Skip to content

Commit d62f11c

Browse files
authored
Merge pull request #55 from per1234/issue-forms
Use form-based issue templates
2 parents 84da172 + ae0147c commit d62f11c

File tree

3 files changed

+121
-0
lines changed

3 files changed

+121
-0
lines changed

.github/ISSUE_TEMPLATE/bug-report.yml

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Source: https://github.com/arduino/tooling-project-assets/blob/main/issue-templates/forms/general/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: The examples version
33+
description: |
34+
Which version of the "built-in examples" are you using?
35+
_This should be the most recent version available._
36+
validations:
37+
required: true
38+
- type: textarea
39+
id: additional
40+
attributes:
41+
label: Additional context
42+
description: Add any additional information here.
43+
validations:
44+
required: false
45+
- type: checkboxes
46+
id: checklist
47+
attributes:
48+
label: Issue checklist
49+
description: Please double-check that you have done each of the following things before submitting the issue.
50+
options:
51+
- label: I searched for previous reports in [the issue tracker](https://github.com/arduino/arduino-examples/issues?q=)
52+
required: true
53+
- label: I verified the problem still occurs when using the latest version
54+
required: true
55+
- label: My report contains all necessary details
56+
required: true

.github/ISSUE_TEMPLATE/config.yml

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Source: https://github.com/arduino/tooling-project-assets/blob/main/issue-templates/template-choosers/general/config.yml
2+
# See: https://docs.github.com/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
3+
4+
blank_issues_enabled: false
5+
contact_links:
6+
- name: Learn about using this project
7+
url: https://github.com/arduino/arduino-examples#readme
8+
about: Detailed usage documentation is available here.
9+
- name: Support request
10+
url: https://forum.arduino.cc/
11+
about: We can help you out on the Arduino Forum!
12+
- name: Discuss development work on the project
13+
url: https://groups.google.com/a/arduino.cc/g/developers
14+
about: Arduino Developers Mailing List
+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Source: https://github.com/arduino/tooling-project-assets/blob/main/issue-templates/forms/general/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 the project in relation to your request?
21+
How can we reproduce that behavior?
22+
validations:
23+
required: true
24+
- type: input
25+
id: project-version
26+
attributes:
27+
label: The examples version
28+
description: |
29+
Which version of the "built-in examples" are you using?
30+
_This should be the most recent version available._
31+
validations:
32+
required: true
33+
- type: textarea
34+
id: additional
35+
attributes:
36+
label: Additional context
37+
description: Add any additional information here.
38+
validations:
39+
required: false
40+
- type: checkboxes
41+
id: checklist
42+
attributes:
43+
label: Issue checklist
44+
description: Please double-check that you have done each of the following things before submitting the issue.
45+
options:
46+
- label: I searched for previous requests in [the issue tracker](https://github.com/arduino/arduino-examples/issues?q=)
47+
required: true
48+
- label: I verified the feature was still missing when using the latest version
49+
required: true
50+
- label: My request contains all necessary details
51+
required: true

0 commit comments

Comments
 (0)