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 <anas.nashif@intel.com>
This commit is contained in:
committed by
Benjamin Cabé
parent
9313df9813
commit
1fbd8d3aa3
71
.github/ISSUE_TEMPLATE/001_bug_report.md
vendored
71
.github/ISSUE_TEMPLATE/001_bug_report.md
vendored
@@ -1,71 +0,0 @@
|
||||
---
|
||||
name: Bug report
|
||||
about: Create a report to help us improve Zephyr
|
||||
title: ''
|
||||
labels: bug
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
<!--
|
||||
**Notes**
|
||||
Github Discussions (https://github.com/zephyrproject-rtos/zephyr/discussions)
|
||||
are available to first verify that the issue is a genuine Zephyr bug and not a
|
||||
consequence of Zephyr services misuse.
|
||||
|
||||
This issue list is only for bugs in the main Zephyr code base
|
||||
(https://github.com/zephyrproject-rtos/zephyr/). If the bug is for a project
|
||||
fork (such as NCS) specific feature, please open an issue in the fork project
|
||||
instead.
|
||||
-->
|
||||
|
||||
**Describe the bug**
|
||||
<!--
|
||||
A clear and concise description of what the bug is.
|
||||
|
||||
Please also mention any information which could help others to understand
|
||||
the problem you're facing:
|
||||
- What target platform are you using?
|
||||
- What have you tried to diagnose or workaround this issue?
|
||||
- Is this a regression? If yes, have you been able to "git bisect" it to a
|
||||
specific commit?
|
||||
- ...
|
||||
-->
|
||||
|
||||
**To Reproduce**
|
||||
<!--
|
||||
Steps to reproduce the behavior:
|
||||
1. mkdir build; cd build
|
||||
2. cmake -DBOARD=board\_xyz
|
||||
3. make
|
||||
4. See error
|
||||
-->
|
||||
|
||||
**Expected behavior**
|
||||
<!--
|
||||
A clear and concise description of what you expected to happen.
|
||||
-->
|
||||
|
||||
**Impact**
|
||||
<!--
|
||||
What impact does this issue have on your progress (e.g., annoyance, showstopper)
|
||||
-->
|
||||
|
||||
**Logs and console output**
|
||||
<!--
|
||||
If applicable, add console logs or other types of debug information
|
||||
e.g Wireshark capture or Logic analyzer capture (upload in zip archive).
|
||||
copy-and-paste text and put a code fence (\`\`\`) before and after, to help
|
||||
explain the issue. (if unable to obtain text log, add a screenshot)
|
||||
-->
|
||||
|
||||
**Environment (please complete the following information):**
|
||||
|
||||
- OS: (e.g. Linux, MacOS, Windows)
|
||||
- Toolchain (e.g Zephyr SDK, ...)
|
||||
- Commit SHA or Version used
|
||||
|
||||
**Additional context**
|
||||
<!--
|
||||
Add any other context that could be relevant to your issue, such as pin setting,
|
||||
target configuration, ...
|
||||
-->
|
||||
85
.github/ISSUE_TEMPLATE/001_bug_report.yml
vendored
Normal file
85
.github/ISSUE_TEMPLATE/001_bug_report.yml
vendored
Normal file
@@ -0,0 +1,85 @@
|
||||
name: Bug Report
|
||||
description: File a bug report.
|
||||
labels: ["bug"]
|
||||
type: "Bug"
|
||||
assignees: []
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for taking the time to fill out this bug report!
|
||||
- type: textarea
|
||||
id: what-happened
|
||||
attributes:
|
||||
label: Describe the bug
|
||||
description: |
|
||||
A clear and concise description of what the bug is.
|
||||
|
||||
placeholder: |
|
||||
Please also mention any information which could help others to understand
|
||||
the problem you're facing:
|
||||
- What target platform are you using?
|
||||
- What have you tried to diagnose or workaround this issue?
|
||||
- Is this a regression? If yes, have you been able to "git bisect" it to a
|
||||
specific commit?
|
||||
validations:
|
||||
required: true
|
||||
- type: checkboxes
|
||||
id: regression
|
||||
attributes:
|
||||
label: Regression
|
||||
description: |
|
||||
Check this box if this is a regression and provide a SHA if you were able to "git bisect" to a specific commit.
|
||||
options:
|
||||
- label: This is a regression.
|
||||
required: false
|
||||
- type: textarea
|
||||
id: reproduce
|
||||
attributes:
|
||||
label: Steps to reproduce
|
||||
description: |
|
||||
Steps to reproduce the behavior.
|
||||
|
||||
placeholder: |
|
||||
Steps to reproduce the behavior:
|
||||
1. mkdir build; cd build
|
||||
2. cmake -DBOARD=board\_xyz
|
||||
3. make
|
||||
4. See error
|
||||
validations:
|
||||
required: false
|
||||
- type: textarea
|
||||
id: logs
|
||||
attributes:
|
||||
label: Relevant log output
|
||||
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
|
||||
render: shell
|
||||
- type: dropdown
|
||||
attributes:
|
||||
label: Impact
|
||||
description: Impact of this bug
|
||||
multiple: false
|
||||
options:
|
||||
- Showstopper – Prevents release or major functionality; system unusable.
|
||||
- Major – Severely degrades functionality; workaround is difficult or unavailable.
|
||||
- Functional Limitation – Some features not working as expected, but system usable.
|
||||
- Annoyance – Minor irritation; no significant impact on usability or functionality.
|
||||
- Intermittent – Occurs occasionally; hard to reproduce.
|
||||
- Not sure
|
||||
default: 3
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: env
|
||||
attributes:
|
||||
label: Environment
|
||||
description: please complete the following information
|
||||
placeholder: |
|
||||
- OS: (e.g. Linux, MacOS, Windows)
|
||||
- Toolchain (e.g Zephyr SDK, ...)
|
||||
- Commit SHA or Version used
|
||||
- type: textarea
|
||||
id: context
|
||||
attributes:
|
||||
label: Additional Context
|
||||
description: Provide other context that could be relevant to the bug, such as pin setting, target configuration,etc.
|
||||
5
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
5
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
@@ -0,0 +1,5 @@
|
||||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: Zephyr Community Support
|
||||
url: https://github.com/zephyrproject-rtos/zephyr/discussions
|
||||
about: Please ask and answer questions here.
|
||||
Reference in New Issue
Block a user