adafruit-mirror/zephyr
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 9

github: add template text as comments

Browse source 
Instead of including the boilerplate text and showing it in the created
issue, use comments that are still displayed when editing, but not shown
in the final issue, avoiding confusing and mixup between actual issue
and template text.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
Anas Nashif 2024-07-10 06:05:13 -04:00
parent f9672c4700
commit 9864852540
4 changed files with 48 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
.github/ISSUE_TEMPLATE/001_bug_report.md vendored
View file

@ -6,8 +6,8 @@ labels: bug
assignees: '' assignees: ''
--- ---
<!--
**Notes (delete this)** **Notes**
Github Discussions (https://github.com/zephyrproject-rtos/zephyr/discussions) 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 are available to first verify that the issue is a genuine Zephyr bug and not a
consequence of Zephyr services misuse. consequence of Zephyr services misuse.
@ -16,8 +16,10 @@ 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 (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 fork (such as NCS) specific feature, please open an issue in the fork project
instead. instead.
-->
**Describe the bug** **Describe the bug**
<!--
A clear and concise description of what the bug is. A clear and concise description of what the bug is.
Please also mention any information which could help others to understand Please also mention any information which could help others to understand
@ -27,31 +29,43 @@ the problem you're facing:
- Is this a regression? If yes, have you been able to "git bisect" it to a - Is this a regression? If yes, have you been able to "git bisect" it to a
specific commit? specific commit?
- ... - ...
-->
**To Reproduce** **To Reproduce**
<!--
Steps to reproduce the behavior: Steps to reproduce the behavior:
1. mkdir build; cd build 1. mkdir build; cd build
2. cmake -DBOARD=board\_xyz 2. cmake -DBOARD=board\_xyz
3. make 3. make
4. See error 4. See error
-->
**Expected behavior** **Expected behavior**
<!--
A clear and concise description of what you expected to happen. A clear and concise description of what you expected to happen.
-->
**Impact** **Impact**
<!--
What impact does this issue have on your progress (e.g., annoyance, showstopper) What impact does this issue have on your progress (e.g., annoyance, showstopper)
-->
**Logs and console output** **Logs and console output**
<!--
If applicable, add console logs or other types of debug information If applicable, add console logs or other types of debug information
e.g Wireshark capture or Logic analyzer capture (upload in zip archive). 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 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) explain the issue. (if unable to obtain text log, add a screenshot)
-->
**Environment (please complete the following information):** **Environment (please complete the following information):**
- OS: (e.g. Linux, MacOS, Windows) - OS: (e.g. Linux, MacOS, Windows)
- Toolchain (e.g Zephyr SDK, ...) - Toolchain (e.g Zephyr SDK, ...)
- Commit SHA or Version used - Commit SHA or Version used
**Additional context** **Additional context**
<!--
Add any other context that could be relevant to your issue, such as pin setting, Add any other context that could be relevant to your issue, such as pin setting,
target configuration, ... target configuration, ...
-->

8
.github/ISSUE_TEMPLATE/002_enhancement.md vendored
View file

@ -8,13 +8,21 @@ assignees: ''
--- ---
**Is your enhancement proposal related to a problem? Please describe.** **Is your enhancement proposal related to a problem? Please describe.**
<!--
A clear and concise description of what the problem is. A clear and concise description of what the problem is.
-->
**Describe the solution you'd like** **Describe the solution you'd like**
<!--
A clear and concise description of what you want to happen. A clear and concise description of what you want to happen.
-->
**Describe alternatives you've considered** **Describe alternatives you've considered**
<!--
A clear and concise description of any alternative solutions or features you've considered. A clear and concise description of any alternative solutions or features you've considered.
-->
**Additional context** **Additional context**
<!--
Add any other context or graphics (drag-and-drop an image) about the feature request here. Add any other context or graphics (drag-and-drop an image) about the feature request here.
-->

23
.github/ISSUE_TEMPLATE/003_rfc-proposal.md vendored
View file

@ -9,43 +9,52 @@ assignees: ''
## Introduction ## Introduction
<!--
This section targets end users, TSC members, maintainers and anyone else that might This section targets end users, TSC members, maintainers and anyone else that might
need a quick explanation of your proposed change. need a quick explanation of your proposed change.
-->
### Problem description ### Problem description
<!--
Why do we want this change and what problem are we trying to address? Why do we want this change and what problem are we trying to address?
-->
### Proposed change ### Proposed change
<!--
A brief summary of the proposed change - the 10,000 ft view on what it will A brief summary of the proposed change - the 10,000 ft view on what it will
change once this change is implemented. change once this change is implemented.
-->
## Detailed RFC ## Detailed RFC
<!--
In this section of the document the target audience is the dev team. Upon In this section of the document the target audience is the dev team. Upon
reading this section each engineer should have a rather clear picture of what reading this section each engineer should have a rather clear picture of what
needs to be done in order to implement the described feature. needs to be done in order to implement the described feature.
-->
### Proposed change (Detailed) ### Proposed change (Detailed)
<!--
This section is freeform - you should describe your change in as much detail This section is freeform - you should describe your change in as much detail
as possible. Please also ensure to include any context or background info here. as possible. Please also ensure to include any context or background info here.
For example, do we have existing components which can be reused or altered. For example, do we have existing components which can be reused or altered.
By reading this section, each team member should be able to know what exactly By reading this section, each team member should be able to know what exactly
you're planning to change and how. you're planning to change and how.
-->
### Dependencies ### Dependencies
<!--
Highlight how the change may affect the rest of the project (new components, Highlight how the change may affect the rest of the project (new components,
modifications in other areas), or other teams/projects. modifications in other areas), or other teams/projects.
-->
### Concerns and Unresolved Questions ### Concerns and Unresolved Questions
<!--
List any concerns, unknowns, and generally unresolved questions etc. List any concerns, unknowns, and generally unresolved questions etc.
-->
## Alternatives ## Alternatives
<!--
List any alternatives considered, and the reasons for choosing this option List any alternatives considered, and the reasons for choosing this option
over them. over them.
-->

8
.github/ISSUE_TEMPLATE/004_feature_request.md vendored
View file

@ -8,13 +8,21 @@ assignees: ''
--- ---
**Is your feature request related to a problem? Please describe.** **Is your feature request related to a problem? Please describe.**
<!--
A clear and concise description of what the problem is. A clear and concise description of what the problem is.
-->
**Describe the solution you'd like** **Describe the solution you'd like**
<!--
A clear and concise description of what you want to happen. A clear and concise description of what you want to happen.
-->
**Describe alternatives you've considered** **Describe alternatives you've considered**
<!--
A clear and concise description of any alternative solutions or features you've considered. A clear and concise description of any alternative solutions or features you've considered.
-->
**Additional context** **Additional context**
<!--
Add any other context or graphics (drag-and-drop an image) about the feature request here. Add any other context or graphics (drag-and-drop an image) about the feature request here.
-->