Skip to content

Commit 82ba5a0

Browse files
Chris Friedtdanieldegrasse
authored andcommitted
github: add issue templates for bug, enhancement, rfc, and feature req
Add issue templates from the Zephyr project for bug, enhancement, rfc, and feature request issues. Signed-off-by: Chris Friedt <[email protected]>
1 parent c78bb19 commit 82ba5a0

File tree

4 files changed

+176
-0
lines changed

4 files changed

+176
-0
lines changed
Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve Tenstorrent Firmware
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
<!--
12+
A clear and concise description of what the bug is.
13+
14+
Please also mention any information which could help others to understand
15+
the problem you're facing:
16+
- What target platform are you using?
17+
- What have you tried to diagnose or workaround this issue?
18+
- Is this a regression? If yes, have you been able to "git bisect" it to a
19+
specific commit?
20+
- ...
21+
-->
22+
23+
**To Reproduce**
24+
<!--
25+
Steps to reproduce the behavior:
26+
1. mkdir build; cd build
27+
2. cmake -DBOARD=board\_xyz
28+
3. make
29+
4. See error
30+
-->
31+
32+
**Expected behavior**
33+
<!--
34+
A clear and concise description of what you expected to happen.
35+
-->
36+
37+
**Impact**
38+
<!--
39+
What impact does this issue have on your progress (e.g., annoyance, showstopper)
40+
-->
41+
42+
**Logs and console output**
43+
<!--
44+
If applicable, add console logs or other types of debug information
45+
e.g Wireshark capture or Logic analyzer capture (upload in zip archive).
46+
copy-and-paste text and put a code fence (\`\`\`) before and after, to help
47+
explain the issue. (if unable to obtain text log, add a screenshot)
48+
-->
49+
50+
**Environment (please complete the following information):**
51+
52+
- OS: (e.g. Linux, MacOS, Windows)
53+
- Toolchain (e.g Zephyr SDK, ...)
54+
- Commit SHA or Version used
55+
56+
**Additional context**
57+
<!--
58+
Add any other context that could be relevant to your issue, such as pin setting,
59+
target configuration, ...
60+
-->
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
name: Enhancement
3+
about: Suggest enhancements to existing features
4+
title: ''
5+
labels: Enhancement
6+
assignees: ''
7+
8+
---
9+
10+
**Is your enhancement proposal related to a problem? Please describe.**
11+
<!--
12+
A clear and concise description of what the problem is.
13+
-->
14+
15+
**Describe the solution you'd like**
16+
<!--
17+
A clear and concise description of what you want to happen.
18+
-->
19+
20+
**Describe alternatives you've considered**
21+
<!--
22+
A clear and concise description of any alternative solutions or features you've considered.
23+
-->
24+
25+
**Additional context**
26+
<!--
27+
Add any other context or graphics (drag-and-drop an image) about the feature request here.
28+
-->
Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
name: RFC / Proposal
3+
about: Submit an RFC / Proposal
4+
title: ''
5+
labels: RFC
6+
assignees: ''
7+
8+
---
9+
10+
## Introduction
11+
12+
<!--
13+
This section targets end users, TSC members, maintainers and anyone else that might
14+
need a quick explanation of your proposed change.
15+
-->
16+
17+
### Problem description
18+
<!--
19+
Why do we want this change and what problem are we trying to address?
20+
-->
21+
22+
### Proposed change
23+
<!--
24+
A brief summary of the proposed change - the 10,000 ft view on what it will
25+
change once this change is implemented.
26+
-->
27+
28+
## Detailed RFC
29+
<!--
30+
In this section of the document the target audience is the dev team. Upon
31+
reading this section each engineer should have a rather clear picture of what
32+
needs to be done in order to implement the described feature.
33+
-->
34+
35+
### Proposed change (Detailed)
36+
<!--
37+
This section is freeform - you should describe your change in as much detail
38+
as possible. Please also ensure to include any context or background info here.
39+
For example, do we have existing components which can be reused or altered.
40+
41+
By reading this section, each team member should be able to know what exactly
42+
you're planning to change and how.
43+
-->
44+
45+
### Dependencies
46+
<!--
47+
Highlight how the change may affect the rest of the project (new components,
48+
modifications in other areas), or other teams/projects.
49+
-->
50+
51+
### Concerns and Unresolved Questions
52+
<!--
53+
List any concerns, unknowns, and generally unresolved questions etc.
54+
-->
55+
56+
## Alternatives
57+
<!--
58+
List any alternatives considered, and the reasons for choosing this option
59+
over them.
60+
-->
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: Feature Request
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
<!--
12+
A clear and concise description of what the problem is.
13+
-->
14+
15+
**Describe the solution you'd like**
16+
<!--
17+
A clear and concise description of what you want to happen.
18+
-->
19+
20+
**Describe alternatives you've considered**
21+
<!--
22+
A clear and concise description of any alternative solutions or features you've considered.
23+
-->
24+
25+
**Additional context**
26+
<!--
27+
Add any other context or graphics (drag-and-drop an image) about the feature request here.
28+
-->

0 commit comments

Comments
 (0)