Skip to content

Commit 1fbd8d3

Browse files
nashifkartben
authored andcommitted
templates: use a new bug template based on forms.
Use a form based template instead of freesyle template. This will force bug reporters to follow the template and provide the needed information and will make triage easier and bug reports consistent. Signed-off-by: Anas Nashif <[email protected]>
1 parent 9313df9 commit 1fbd8d3

File tree

3 files changed

+90
-71
lines changed

3 files changed

+90
-71
lines changed

.github/ISSUE_TEMPLATE/001_bug_report.md

Lines changed: 0 additions & 71 deletions
This file was deleted.
Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
name: Bug Report
2+
description: File a bug report.
3+
labels: ["bug"]
4+
type: "Bug"
5+
assignees: []
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for taking the time to fill out this bug report!
11+
- type: textarea
12+
id: what-happened
13+
attributes:
14+
label: Describe the bug
15+
description: |
16+
A clear and concise description of what the bug is.
17+
18+
placeholder: |
19+
Please also mention any information which could help others to understand
20+
the problem you're facing:
21+
- What target platform are you using?
22+
- What have you tried to diagnose or workaround this issue?
23+
- Is this a regression? If yes, have you been able to "git bisect" it to a
24+
specific commit?
25+
validations:
26+
required: true
27+
- type: checkboxes
28+
id: regression
29+
attributes:
30+
label: Regression
31+
description: |
32+
Check this box if this is a regression and provide a SHA if you were able to "git bisect" to a specific commit.
33+
options:
34+
- label: This is a regression.
35+
required: false
36+
- type: textarea
37+
id: reproduce
38+
attributes:
39+
label: Steps to reproduce
40+
description: |
41+
Steps to reproduce the behavior.
42+
43+
placeholder: |
44+
Steps to reproduce the behavior:
45+
1. mkdir build; cd build
46+
2. cmake -DBOARD=board\_xyz
47+
3. make
48+
4. See error
49+
validations:
50+
required: false
51+
- type: textarea
52+
id: logs
53+
attributes:
54+
label: Relevant log output
55+
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
56+
render: shell
57+
- type: dropdown
58+
attributes:
59+
label: Impact
60+
description: Impact of this bug
61+
multiple: false
62+
options:
63+
- Showstopper – Prevents release or major functionality; system unusable.
64+
- Major – Severely degrades functionality; workaround is difficult or unavailable.
65+
- Functional Limitation – Some features not working as expected, but system usable.
66+
- Annoyance – Minor irritation; no significant impact on usability or functionality.
67+
- Intermittent – Occurs occasionally; hard to reproduce.
68+
- Not sure
69+
default: 3
70+
validations:
71+
required: true
72+
- type: textarea
73+
id: env
74+
attributes:
75+
label: Environment
76+
description: please complete the following information
77+
placeholder: |
78+
- OS: (e.g. Linux, MacOS, Windows)
79+
- Toolchain (e.g Zephyr SDK, ...)
80+
- Commit SHA or Version used
81+
- type: textarea
82+
id: context
83+
attributes:
84+
label: Additional Context
85+
description: Provide other context that could be relevant to the bug, such as pin setting, target configuration,etc.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Zephyr Community Support
4+
url: https://github.com/zephyrproject-rtos/zephyr/discussions
5+
about: Please ask and answer questions here.

0 commit comments

Comments
 (0)