Skip to content

Commit 419936d

Browse files
kchudykchudy
authored
Added new issue templates (#258)
1 parent 1c88f69 commit 419936d

File tree

4 files changed

+207
-0
lines changed

4 files changed

+207
-0
lines changed

‎.github/ISSUE_TEMPLATE/01-feature-request.yml‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
name: Feature request
2+
description: Suggest an idea or improvement for Defguard
3+
title: "[Feature]: "
4+
labels:
5+
- feature
6+
type: feature
7+
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: |
12+
Thank you for suggesting a feature. Your feedback helps improve Defguard.
13+
14+
- type: textarea
15+
id: problem
16+
attributes:
17+
label: Problem description
18+
description: What problem are you trying to solve? Attach screenshots or recording if it helps illustrate the problem.
19+
placeholder: |
20+
Describe the limitation, friction, or missing capability.
21+
Example: "Users cannot restrict access based on device posture..."
22+
validations:
23+
required: true
24+
25+
- type: textarea
26+
id: proposed_solution
27+
attributes:
28+
label: Proposed solution
29+
description: Describe the solution you would like. Attach mockups or diagrams if you have them.
30+
placeholder: |
31+
Describe the desired behavior, API, UI, or workflow.
32+
Include examples if possible.
33+
validations:
34+
required: true
35+
36+
- type: textarea
37+
id: alternatives
38+
attributes:
39+
label: Alternatives considered
40+
description: Any alternative solutions or workarounds you've considered
41+
placeholder: |
42+
Example: "Currently we use separate locations, but this is hard to manage..."
43+
validations:
44+
required: false
45+
46+
- type: dropdown
47+
id: impact
48+
attributes:
49+
label: Impact
50+
description: How important is this feature for you?
51+
options:
52+
- Nice to have
53+
- Important
54+
- Critical / blocking our usage
55+
validations:
56+
required: true

‎.github/ISSUE_TEMPLATE/02-bug.yml‎

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
name: Bug report
2+
description: Report a problem in Defguard so we can reproduce and fix it.
3+
title: "[Bug]: "
4+
labels:
5+
- bug
6+
type: bug
7+
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: |
12+
Thanks for taking the time to report a bug.
13+
14+
**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.
15+
16+
- type: textarea
17+
id: summary
18+
attributes:
19+
label: Summary
20+
description: A clear, one-paragraph description of what’s broken.
21+
placeholder: "After enabling MFA for a user, Desktop client cannot start a session; it loops on …"
22+
validations:
23+
required: true
24+
25+
- type: textarea
26+
id: steps
27+
attributes:
28+
label: Steps to reproduce
29+
description: Numbered steps help us reproduce reliably. Attach screenshots or recordings if they help illustrate the steps.
30+
placeholder: |
31+
1. Go to …
32+
2. Click …
33+
3. Configure …
34+
4. Observe …
35+
validations:
36+
required: true
37+
38+
- type: textarea
39+
id: expected
40+
attributes:
41+
label: Expected behavior
42+
description: What should happen if the bug were fixed?
43+
placeholder: "VPN connects successfully and a session is established."
44+
validations:
45+
required: true
46+
47+
- type: textarea
48+
id: actual
49+
attributes:
50+
label: Actual behavior
51+
description: What happens instead? Include error messages, screenshots, or recordings if they help illustrate the issue.
52+
placeholder: "VPN connection fails with … / UI shows … / API returns …"
53+
validations:
54+
required: true
55+
56+
- type: input
57+
id: version
58+
attributes:
59+
label: Defguard version
60+
description: Exact versions of all components.
61+
placeholder: "Core: v1.6.0, Gateway: v1.6.0, Edge: v1.6.0, Desktop client: v1.6.0, Mobile client: v1.6.0."
62+
validations:
63+
required: true
64+
65+
- type: input
66+
id: environment
67+
attributes:
68+
label: Environment details
69+
description: Operating systems of all components.
70+
placeholder: "Core: Ubuntu 24.04, Gateway: Ubuntu 24.04, Edge: Ubuntu 24.04, Desktop client: macOS 15.x, Mobile client: iOS 18."
71+
validations:
72+
required: true
73+
74+
- type: dropdown
75+
id: deployment
76+
attributes:
77+
label: Deployment / install method
78+
description: How is Defguard installed?
79+
multiple: false
80+
options:
81+
- One-line script
82+
- Standalone packages
83+
- Docker / Docker Compose
84+
- Kubernetes / Helm
85+
- Terraform
86+
- AMI
87+
- Custom
88+
validations:
89+
required: true
90+
91+
- type: textarea
92+
id: logs
93+
attributes:
94+
label: Relevant logs / output
95+
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).
96+
render: shell
97+
placeholder: |
98+
# Core logs
99+
[2024-06-01T12:00:00Z] ERROR: ...
100+
101+
# Edge logs
102+
[2024-06-01T12:00:00Z] ERROR: ...
103+
104+
# Gateway logs
105+
[2024-06-01T12:00:00Z] ERROR: ...
106+
107+
# Desktop client logs (you can find them in the app's settings)
108+
[2024-06-01T12:00:00Z] ERROR: ...
109+
110+
# Mobile client logs (you can find them in the app's main menu - View Application Logs)
111+
[2024-06-01T12:00:00Z] ERROR: ...
112+
validations:
113+
required: false
114+
115+
- type: textarea
116+
id: config
117+
attributes:
118+
label: Relevant configuration (redacted)
119+
description: If configuration is involved (LDAP, OIDC, WireGuard, gRPC certs), paste the minimum snippet.
120+
render: yaml
121+
placeholder: |
122+
# Redact secrets/certs/private keys
123+
validations:
124+
required: false

‎.github/ISSUE_TEMPLATE/03-internal.yml‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: Internal issue
2+
description: Internal Defguard team use only
3+
labels:
4+
- internal
5+
type: task
6+
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
This template is intended for internal Defguard team use.
12+
13+
- type: textarea
14+
id: description
15+
attributes:
16+
label: Description
17+
placeholder: Detailed description, context, links, notes
18+
validations:
19+
required: false

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Defguard Troubleshooting Guide
4+
url: https://docs.defguard.net/support-1/troubleshooting
5+
about: Make sure to check the troubleshooting guide before submitting an issue. It has solutions for common problems and can help you debug faster.
6+
- name: Open a discussion to get help from the community
7+
url: https://github.com/DefGuard/defguard/discussions/new/choose
8+
about: Having trouble with Defguard deployment or configuration? Reach out to our community for help.

0 commit comments

Comments
 (0)