Skip to content

Commit 51c6fa1

Browse files
acmlauarangatang
acmlau
and
arangatang
authored
Setup issue management (#10)
* Setup issue management * Addressing comments on bug_report * Addressing comments on bug_report * Update .github/ISSUE_TEMPLATE/bug_report.yml Co-authored-by: Leonardo Araneda Freccero <arangatang@users.noreply.github.com> Signed-off-by: Anna Lau <66322063+acmlau@users.noreply.github.com> --------- Signed-off-by: Anna Lau <66322063+acmlau@users.noreply.github.com> Co-authored-by: Leonardo Araneda Freccero <arangatang@users.noreply.github.com>
1 parent 8670897 commit 51c6fa1

3 files changed

Lines changed: 169 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
---
2+
name: "🐛 Bug Report"
3+
description: Report a bug
4+
title: "Short issue description"
5+
labels: [bug]
6+
assignees: []
7+
body:
8+
- type: textarea
9+
id: description
10+
attributes:
11+
label: Describe the bug
12+
description: What is the problem? A clear and concise description of the bug.
13+
validations:
14+
required: true
15+
- type: textarea
16+
id: expected
17+
attributes:
18+
label: Expected Behavior
19+
description: |
20+
What did you expect to happen?
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: current
25+
attributes:
26+
label: Current Behavior
27+
description: |
28+
What actually happened?
29+
30+
Please include full errors, uncaught exceptions, stack traces, and relevant logs.
31+
validations:
32+
required: true
33+
- type: textarea
34+
id: reproduction
35+
attributes:
36+
label: Reproduction Steps
37+
description: |
38+
Provide a self-contained, concise snippet of code that can be used to reproduce the issue.
39+
For more complex issues provide a repo with the smallest sample that reproduces the bug.
40+
41+
Avoid including business logic or unrelated code, it makes diagnosis more difficult.
42+
The code sample should be an SSCCE. See http://sscce.org/ for details. In short, please provide a code sample that we can copy/paste, run and reproduce.
43+
validations:
44+
required: true
45+
- type: textarea
46+
id: solution
47+
attributes:
48+
label: Possible Solution
49+
description: |
50+
Suggest a fix/reason for the bug
51+
validations:
52+
required: false
53+
- type: textarea
54+
id: context
55+
attributes:
56+
label: Additional Information/Context
57+
description: |
58+
Anything else that might be relevant for troubleshooting this bug. Providing context helps us come up with a solution that is most useful in the real world.
59+
validations:
60+
required: false
61+
62+
- type: input
63+
id: operating-system
64+
attributes:
65+
label: Operating System
66+
validations:
67+
required: true
68+
69+
- type: input
70+
id: version
71+
attributes:
72+
label: Release Version
73+
validations:
74+
required: true
75+
76+
- type: textarea
77+
id: other
78+
attributes:
79+
label: Other information
80+
description: |
81+
e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. associated pull-request, stackoverflow, slack, etc
82+
validations:
83+
required: false
84+
85+
- type: checkboxes
86+
id: search-verification
87+
attributes:
88+
label: Search verification
89+
description: Please verify that you have completed the following
90+
options:
91+
- label: I have searched existing issues and verified this is not a duplicate
92+
required: true
93+
- type: textarea
94+
id: related-issues
95+
attributes:
96+
label: Related issues
97+
description: "Are there any related issues? If so, please link them here (e.g., #123, #456)"
98+
placeholder: "#123, #456, or type 'None'"
99+
validations:
100+
required: true

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
name: 🚀 Feature Request
3+
description: Suggest an idea for this project
4+
title: "Short feature description"
5+
labels: [feature-request]
6+
assignees: []
7+
body:
8+
- type: textarea
9+
id: description
10+
attributes:
11+
label: Describe the feature
12+
description: A clear and concise description of the feature you are proposing.
13+
validations:
14+
required: true
15+
- type: textarea
16+
id: use-case
17+
attributes:
18+
label: Use Case
19+
description: |
20+
Why do you need this feature? For example: "I'm always frustrated when..."
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: solution
25+
attributes:
26+
label: Proposed Solution
27+
description: |
28+
Suggest how to implement the addition or change. Please include prototype/workaround/sketch/reference implementation.
29+
validations:
30+
required: false
31+
- type: textarea
32+
id: other
33+
attributes:
34+
label: Other Information
35+
description: |
36+
Any alternative solutions or features you considered, a more detailed explanation, stack traces, related issues, links for context, etc.
37+
validations:
38+
required: false
39+
- type: checkboxes
40+
id: ack
41+
attributes:
42+
label: Acknowledgements
43+
options:
44+
- label: I may be able to implement this feature request
45+
required: false
46+
- label: This feature might incur a breaking change
47+
required: false

‎.github/ISSUE_TEMPLATE/questions.yml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: 💭 Questions
3+
description: Ask a question about this project
4+
title: "Short question description"
5+
labels: [question]
6+
assignees: []
7+
body:
8+
- type: textarea
9+
id: question
10+
attributes:
11+
label: Your question
12+
description: A clear and concise description of the question.
13+
validations:
14+
required: true
15+
- type: textarea
16+
id: context
17+
attributes:
18+
label: Context
19+
description: |
20+
Any relevant context about your question.
21+
validations:
22+
required: true

0 commit comments

Comments
 (0)