Skip to content

Commit 1643009

Browse files
committed
docs: add bug report and feature request issue templates for better user feedback
1 parent e2c472a commit 1643009

File tree

2 files changed

+93
-0
lines changed

2 files changed

+93
-0
lines changed
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Source: https://github.com/arduino/tooling-project-assets/blob/main/issue-templates/forms/platform-dependent/bug-report.yml
2+
# See: https://docs.github.com/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
3+
4+
name: Bug report
5+
description: Report a problem with the code or documentation in this repository.
6+
labels:
7+
- "type: imperfection"
8+
body:
9+
- type: textarea
10+
id: description
11+
attributes:
12+
label: Describe the problem
13+
validations:
14+
required: true
15+
- type: textarea
16+
id: reproduce
17+
attributes:
18+
label: To reproduce
19+
description: Provide the specific set of steps we can follow to reproduce the problem.
20+
validations:
21+
required: true
22+
- type: textarea
23+
id: expected
24+
attributes:
25+
label: Expected behavior
26+
description: What would you expect to happen after following those instructions?
27+
validations:
28+
required: true
29+
- type: input
30+
id: project-version
31+
attributes:
32+
label: Arduino App CLI version
33+
description: |
34+
Which version of Arduino App CLI are you using? (output of `arduino-app-cli version`)
35+
_This should be the most recent version available._
36+
validations:
37+
required: true
38+
- type: checkboxes
39+
id: checklist
40+
attributes:
41+
label: Issue checklist
42+
description: Please double-check that you have done each of the following things before submitting the issue.
43+
options:
44+
- label: I searched for previous reports in [the issue tracker](https://github.com/arduino/arduino-app-cli/issues?q=)
45+
required: true
46+
- label: I verified the problem still occurs when using the latest version
47+
required: true
48+
- label: My report contains all necessary details
49+
required: true
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Source: https://github.com/arduino/tooling-project-assets/blob/main/issue-templates/forms/platform-dependent/bug-report.yml
2+
# See: https://docs.github.com/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
3+
4+
name: Feature request
5+
description: Suggest an enhancement to this project.
6+
labels:
7+
- "type: enhancement"
8+
body:
9+
- type: textarea
10+
id: description
11+
attributes:
12+
label: Describe the request
13+
validations:
14+
required: true
15+
- type: textarea
16+
id: current
17+
attributes:
18+
label: Describe the current behavior
19+
description: |
20+
What is the current behavior of Arduino App CLI in relation to your request? (output of `arduino-app-cli version`)
21+
How can we reproduce that behavior?
22+
validations:
23+
required: true
24+
- type: input
25+
id: project-version
26+
attributes:
27+
label: Arduino App CLI version
28+
description: |
29+
Which version of Arduino App CLI are you using? (output of `arduino-app-cli version`)
30+
_This should be the most recent version available._
31+
validations:
32+
required: true
33+
- type: checkboxes
34+
id: checklist
35+
attributes:
36+
label: Issue checklist
37+
description: Please double-check that you have done each of the following things before submitting the issue.
38+
options:
39+
- label: I searched for previous requests in [the issue tracker](https://github.com/arduino/arduino-app-cli/issues?q=)
40+
required: true
41+
- label: I verified the feature was still missing when using the latest version
42+
required: true
43+
- label: My request contains all necessary details
44+
required: true

0 commit comments

Comments
 (0)