From 9a8d7829fae033b204845e3b39d94be2819d2964 Mon Sep 17 00:00:00 2001 From: Kamil Chudy Date: Thu, 26 Feb 2026 22:31:34 +0100 Subject: [PATCH 1/2] Added new issue templates --- .github/ISSUE_TEMPLATE/01-feature-request.yml | 77 +++++++++ .github/ISSUE_TEMPLATE/02-bug.yml | 146 ++++++++++++++++++ .github/ISSUE_TEMPLATE/03-internal.yml | 19 +++ .github/ISSUE_TEMPLATE/config.yml | 8 + 4 files changed, 250 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/01-feature-request.yml create mode 100644 .github/ISSUE_TEMPLATE/02-bug.yml create mode 100644 .github/ISSUE_TEMPLATE/03-internal.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/01-feature-request.yml b/.github/ISSUE_TEMPLATE/01-feature-request.yml new file mode 100644 index 0000000..0f75670 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/01-feature-request.yml @@ -0,0 +1,77 @@ +name: Feature request +description: Suggest an idea or improvement for Defguard +title: "[Feature]: " +labels: + - feature +type: feature + +body: + - type: markdown + attributes: + value: | + Thank you for suggesting a feature. Your feedback helps improve Defguard. + + - type: textarea + id: problem + attributes: + label: Problem description + description: What problem are you trying to solve? Attach screenshots or recording if it helps illustrate the problem. + placeholder: | + Describe the limitation, friction, or missing capability. + Example: "Users cannot restrict access based on device posture..." + validations: + required: true + + - type: textarea + id: proposed_solution + attributes: + label: Proposed solution + description: Describe the solution you would like. Attach mockups or diagrams if you have them. + placeholder: | + Describe the desired behavior, API, UI, or workflow. + Include examples if possible. + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: Alternatives considered + description: Any alternative solutions or workarounds you've considered + placeholder: | + Example: "Currently we use separate locations, but this is hard to manage..." + validations: + required: false + + - type: dropdown + id: impact + attributes: + label: Impact + description: How important is this feature for you? + options: + - Nice to have + - Important + - Critical / blocking our usage + validations: + required: true + + - type: input + id: contact_email + attributes: + label: Contact email + description: Optional, in case we need clarification or want to follow up + placeholder: you@company.com + validations: + required: false + + - type: dropdown + id: purchased_plan + attributes: + label: Purchased plan + description: Helps us prioritize and understand your environment + options: + - Open source (community) + - Business + - Enterprise + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/02-bug.yml b/.github/ISSUE_TEMPLATE/02-bug.yml new file mode 100644 index 0000000..d1a1446 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/02-bug.yml @@ -0,0 +1,146 @@ +name: Bug report +description: Report a problem in Defguard so we can reproduce and fix it. +title: "[Bug]: " +labels: + - bug +type: bug + +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to report a bug. + + **Privacy note:** This issue tracker is public. Do not include sensitive data such as secrets, private keys, tokens, passwords, internal domains, or customer data. All data should be anonymised and any secrets must be redacted. + + - type: textarea + id: summary + attributes: + label: Summary + description: A clear, one-paragraph description of what’s broken. + placeholder: "After enabling MFA for a user, Desktop client cannot start a session; it loops on …" + validations: + required: true + + - type: textarea + id: steps + attributes: + label: Steps to reproduce + description: Numbered steps help us reproduce reliably. Attach screenshots or recordings if they help illustrate the steps. + placeholder: | + 1. Go to … + 2. Click … + 3. Configure … + 4. Observe … + validations: + required: true + + - type: textarea + id: expected + attributes: + label: Expected behavior + description: What should happen if the bug were fixed? + placeholder: "VPN connects successfully and a session is established." + validations: + required: true + + - type: textarea + id: actual + attributes: + label: Actual behavior + description: What happens instead? Include error messages, screenshots, or recordings if they help illustrate the issue. + placeholder: "VPN connection fails with … / UI shows … / API returns …" + validations: + required: true + + - type: input + id: version + attributes: + label: Defguard version + description: Exact versions of all components. + placeholder: "Core: v1.6.0, Gateway: v1.6.0, Edge: v1.6.0, Desktop client: v1.6.0, Mobile client: v1.6.0." + validations: + required: true + + - type: input + id: environment + attributes: + label: Environment details + description: Operating systems of all components. + placeholder: "Core: Ubuntu 24.04, Gateway: Ubuntu 24.04, Edge: Ubuntu 24.04, Desktop client: macOS 15.x, Mobile client: iOS 18." + validations: + required: true + + - type: dropdown + id: deployment + attributes: + label: Deployment / install method + description: How is Defguard installed? + multiple: false + options: + - One-line script + - Standalone packages + - Docker / Docker Compose + - Kubernetes / Helm + - Terraform + - AMI + - Custom + validations: + required: true + + - type: textarea + id: logs + attributes: + label: Relevant logs / output + description: Paste only what’s necessary. Please redact secrets (tokens, private IPs, domains) if needed. Enable DEBUG log level if you can (https://docs.defguard.net/support-1/how-to-submit-an-issue#id-1.-enable-debug-logging). + render: shell + placeholder: | + # Core logs + [2024-06-01T12:00:00Z] ERROR: ... + + # Edge logs + [2024-06-01T12:00:00Z] ERROR: ... + + # Gateway logs + [2024-06-01T12:00:00Z] ERROR: ... + + # Desktop client logs (you can find them in the app's settings) + [2024-06-01T12:00:00Z] ERROR: ... + + # Mobile client logs (you can find them in the app's main menu - View Application Logs) + [2024-06-01T12:00:00Z] ERROR: ... + validations: + required: false + + - type: textarea + id: config + attributes: + label: Relevant configuration (redacted) + description: If configuration is involved (LDAP, OIDC, WireGuard, gRPC certs), paste the minimum snippet. + render: yaml + placeholder: | + # Redact secrets/certs/private keys + validations: + required: false + + - type: input + id: contact_email + attributes: + label: Contact email + description: How can we reach you if we need more details? (Optional, but recommended) + placeholder: you@company.com + validations: + required: false + + - type: dropdown + id: purchased_plan + attributes: + label: Purchased plan + description: Helps us route your report and match support expectations. + multiple: false + options: + - Open source (community) + - Business + - Enterprise + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/03-internal.yml b/.github/ISSUE_TEMPLATE/03-internal.yml new file mode 100644 index 0000000..97278a0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/03-internal.yml @@ -0,0 +1,19 @@ +name: Internal issue +description: Internal Defguard team use only +labels: + - internal +type: task + +body: + - type: markdown + attributes: + value: | + This template is intended for internal Defguard team use. + + - type: textarea + id: description + attributes: + label: Description + placeholder: Detailed description, context, links, notes + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..7987ea4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: Defguard Troubleshooting Guide + url: https://docs.defguard.net/support-1/troubleshooting + about: Make sure to check the troubleshooting guide before submitting an issue. It has solutions for common problems and can help you debug faster. + - name: Open a discussion to get help from the community + url: https://github.com/DefGuard/defguard/discussions/new/choose + about: Having trouble with Defguard deployment or configuration? Reach out to our community for help. From 4aa9ad3c711e6ab422af6cce16584d8af4a83b8a Mon Sep 17 00:00:00 2001 From: Kamil Chudy Date: Fri, 27 Feb 2026 11:44:01 +0100 Subject: [PATCH 2/2] Removed email and plan from issue templates --- .github/ISSUE_TEMPLATE/01-feature-request.yml | 21 ------------------ .github/ISSUE_TEMPLATE/02-bug.yml | 22 ------------------- 2 files changed, 43 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/01-feature-request.yml b/.github/ISSUE_TEMPLATE/01-feature-request.yml index 0f75670..13b9410 100644 --- a/.github/ISSUE_TEMPLATE/01-feature-request.yml +++ b/.github/ISSUE_TEMPLATE/01-feature-request.yml @@ -54,24 +54,3 @@ body: - Critical / blocking our usage validations: required: true - - - type: input - id: contact_email - attributes: - label: Contact email - description: Optional, in case we need clarification or want to follow up - placeholder: you@company.com - validations: - required: false - - - type: dropdown - id: purchased_plan - attributes: - label: Purchased plan - description: Helps us prioritize and understand your environment - options: - - Open source (community) - - Business - - Enterprise - validations: - required: true diff --git a/.github/ISSUE_TEMPLATE/02-bug.yml b/.github/ISSUE_TEMPLATE/02-bug.yml index d1a1446..71614db 100644 --- a/.github/ISSUE_TEMPLATE/02-bug.yml +++ b/.github/ISSUE_TEMPLATE/02-bug.yml @@ -122,25 +122,3 @@ body: # Redact secrets/certs/private keys validations: required: false - - - type: input - id: contact_email - attributes: - label: Contact email - description: How can we reach you if we need more details? (Optional, but recommended) - placeholder: you@company.com - validations: - required: false - - - type: dropdown - id: purchased_plan - attributes: - label: Purchased plan - description: Helps us route your report and match support expectations. - multiple: false - options: - - Open source (community) - - Business - - Enterprise - validations: - required: true