Skip to content

Commit 6c90aef

Browse files
authored
chore: add GitHub issue template (#16342)
Adds a GitHub issue template to make it easy to file bug reports. You can test it here: https://github.com/matifali/test-github-issue-template/issues/new/choose
1 parent 2371153 commit 6c90aef

File tree

2 files changed

+88
-0
lines changed

2 files changed

+88
-0
lines changed

.github/ISSUE_TEMPLATE/1-bug.yaml

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
name: "🐞 Bug"
2+
description: "File a bug report."
3+
title: "<title>"
4+
labels: ["needs-triage"]
5+
body:
6+
- type: checkboxes
7+
id: existing_issues
8+
attributes:
9+
label: "Is there an existing issue for this?"
10+
description: "Please search to see if an issue already exists for the bug you encountered."
11+
options:
12+
- label: "I have searched the existing issues"
13+
required: true
14+
15+
- type: textarea
16+
id: issue
17+
attributes:
18+
label: "Current Behavior"
19+
description: "A concise description of what you're experiencing."
20+
placeholder: "Tell us what you see!"
21+
validations:
22+
required: false
23+
24+
- type: textarea
25+
id: logs
26+
attributes:
27+
label: "Relevant Log Output"
28+
description: "Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks."
29+
render: shell
30+
31+
- type: textarea
32+
id: expected
33+
attributes:
34+
label: "Expected Behavior"
35+
description: "A concise description of what you expected to happen."
36+
validations:
37+
required: false
38+
39+
- type: textarea
40+
id: steps_to_reproduce
41+
attributes:
42+
label: "Steps to Reproduce"
43+
description: "Provide step-by-step instructions to reproduce the issue."
44+
placeholder: |
45+
1. First step
46+
2. Second step
47+
3. Another step
48+
4. Issue occurs
49+
validations:
50+
required: true
51+
52+
- type: textarea
53+
id: environment
54+
attributes:
55+
label: "Environment"
56+
description: |
57+
Provide details about your environment:
58+
- **Host OS**: (e.g., Ubuntu 24.04, Debian 12)
59+
- **Coder Version**: (e.g., v2.18.4)
60+
placeholder: |
61+
Run `coder version` to get Coder version
62+
value: |
63+
- Host OS:
64+
- Coder version:
65+
validations:
66+
required: false
67+
68+
- type: dropdown
69+
id: additional_info
70+
attributes:
71+
label: "Additional Context"
72+
description: "Select any applicable options:"
73+
multiple: true
74+
options:
75+
- "The issue occurs consistently"
76+
- "The issue is new (previously worked fine)"
77+
- "The issue happens on multiple deployments"
78+
- "I have tested this on the latest version"

.github/ISSUE_TEMPLATE/config.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
contact_links:
2+
- name: Questions, suggestion or feature requests?
3+
url: https://github.com/coder/coder/discussions/new/choose
4+
about: Our preferred starting point if you have any questions or suggestions about configuration, features or unexpected behavior.
5+
- name: Coder Docs
6+
url: https://coder.com/docs
7+
about: Check our docs.
8+
- name: Coder Discord Community
9+
url: https://discord.gg/coder
10+
about: Get in touch with the Coder developers and community for support.

0 commit comments

Comments
 (0)