Skip to content

Commit 71a9825

Browse files
authored
Update issue templates (#305)
1 parent 6fe355d commit 71a9825

File tree

4 files changed

+98
-0
lines changed

4 files changed

+98
-0
lines changed
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
**Summary**
11+
[A clear and concise description of what the bug is]
12+
13+
**To Reproduce**
14+
1. [Steps to reproduce]
15+
16+
**Expected behavior**
17+
[A clear and concise description of what you expected to happen]
18+
19+
**Actual behavior**
20+
[A clear and concise description of what happens instead]
21+
22+
**Environment**
23+
[Arm Toolchain variant and version, host OS: name, version, architecture]
24+
25+
**[Additional context]**
26+
[Optional: Add any other context about the problem here or remove]
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: Downstream Change
3+
about: Issue to track a Downstream Change
4+
title: "[Downstream Change] "
5+
labels: downstream-change
6+
assignees: ''
7+
8+
---
9+
10+
**What is the change**
11+
[Describe the change here, see CONTRIBUTING.md for details]
12+
13+
**Why this change cannot be done upstream**
14+
[Provide the rationale]
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
**Problem or Opportunity**
11+
[A clear and concise description of what the problem or opportunity to improve is]
12+
13+
**Requested Solution**
14+
[A clear and concise description of what you want to happen]
15+
16+
**Alternatives Considered**
17+
[A clear and concise description of any alternative solutions or features you've considered]
18+
19+
**Additional context**
20+
[Add any other context or screenshots about the feature request here]

.github/ISSUE_TEMPLATE/rfc.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: RFC
3+
about: Request for Comments (RFC)
4+
title: ''
5+
labels: RFC
6+
assignees: ''
7+
8+
---
9+
10+
**Summary**
11+
[A short summary/abstract of what this RFC is about so that readers can quickly judge if they are interested in going into the details or not]
12+
13+
**Background**
14+
[Provide the context: relevant current status and/or history, references to more information]
15+
16+
**Problem (or Opportunity or Goals)**
17+
[Clearly state the problem to solve or the opportunity (goals) to make use of, if this more an improvement/innovation.]
18+
19+
**[Out of Scope]**
20+
[Optional: In cases where people could naturally have expectations/misconceptions about the solution, clearly state what this RFC is not about]
21+
22+
**Proposal**
23+
[Explain and provide relevant details of the actual proposed design or actions]
24+
25+
**[Benefits]**
26+
[Optional: Highlight why the proposal makes sense, especially if this is not a problem solving, but exploiting an opportunity]
27+
28+
**[Implementation or Transition]**
29+
[Optional: Some solutions may need multiple steps to be implemented or require migration/transition period from the previous approach - outline the plan here]
30+
31+
**[Risks]**
32+
[Optional: Consider risks and mitigations, if relevant]
33+
34+
**Alternatives**
35+
[Explain what alternatives exist or were evaluated and rejected, why]
36+
37+
**[Request for Comments]**
38+
[Optional: If it is not obvious, specifically list what questions/insights are asked from reviewers]

0 commit comments

Comments
 (0)