Skip to content

Commit c7950e2

Browse files
per1234per1234
authored
Merge pull request #380 from per1234/issue-forms
Use form-based issue templates
2 parents 4d865f7 + 2f90704 commit c7950e2

File tree

3 files changed

+171
-0
lines changed

3 files changed

+171
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug-report.yml

+81
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
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: markdown
10+
attributes:
11+
value: |
12+
Please see the [contributor guide](https://arduino.github.io/arduino-lint/dev/CONTRIBUTING/) for more information.
13+
- type: textarea
14+
id: description
15+
attributes:
16+
label: Describe the problem
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: reproduce
21+
attributes:
22+
label: To reproduce
23+
description: Provide the specific set of steps we can follow to reproduce the problem.
24+
validations:
25+
required: true
26+
- type: textarea
27+
id: expected
28+
attributes:
29+
label: Expected behavior
30+
description: What would you expect to happen after following those instructions?
31+
validations:
32+
required: true
33+
- type: input
34+
id: project-version
35+
attributes:
36+
label: Arduino Lint version
37+
description: |
38+
Which version of Arduino Lint are you using?
39+
(output of `arduino-lint --version`)
40+
_This should be the [nightly build](https://arduino.github.io/arduino-lint/dev/installation/#nightly-builds)._
41+
validations:
42+
required: true
43+
- type: dropdown
44+
id: os
45+
attributes:
46+
label: Operating system
47+
description: Which operating system(s) are you using on your computer?
48+
multiple: true
49+
options:
50+
- Windows
51+
- Linux
52+
- macOS
53+
- N/A
54+
validations:
55+
required: true
56+
- type: input
57+
id: os-version
58+
attributes:
59+
label: Operating system version
60+
description: Which version of the operating system are you using on your computer?
61+
validations:
62+
required: true
63+
- type: textarea
64+
id: additional
65+
attributes:
66+
label: Additional context
67+
description: Add any additional information here.
68+
validations:
69+
required: false
70+
- type: checkboxes
71+
id: checklist
72+
attributes:
73+
label: Issue checklist
74+
description: Please double-check that you have done each of the following things before submitting the issue.
75+
options:
76+
- label: I searched for previous reports in [the issue tracker](https://github.com/arduino/arduino-lint/issues?q=)
77+
required: true
78+
- label: I verified the problem still occurs when using the latest version
79+
required: true
80+
- label: My report contains all necessary details
81+
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://arduino.github.io/arduino-lint/dev/
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

‎.github/ISSUE_TEMPLATE/feature-request.yml

+76
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
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: markdown
10+
attributes:
11+
value: |
12+
Please see the [contributor guide](https://arduino.github.io/arduino-lint/dev/CONTRIBUTING/) for more information.
13+
- type: textarea
14+
id: description
15+
attributes:
16+
label: Describe the request
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: current
21+
attributes:
22+
label: Describe the current behavior
23+
description: |
24+
What is the current behavior of Arduino Lint in relation to your request?
25+
How can we reproduce that behavior?
26+
validations:
27+
required: true
28+
- type: input
29+
id: project-version
30+
attributes:
31+
label: Arduino Lint version
32+
description: |
33+
Which version of Arduino Lint are you using?
34+
(output of `arduino-lint --version`)
35+
_This should be the [nightly build](https://arduino.github.io/arduino-lint/dev/installation/#nightly-builds)._
36+
validations:
37+
required: true
38+
- type: dropdown
39+
id: os
40+
attributes:
41+
label: Operating system
42+
description: Which operating system(s) are you using on your computer?
43+
multiple: true
44+
options:
45+
- Windows
46+
- Linux
47+
- macOS
48+
- N/A
49+
validations:
50+
required: true
51+
- type: input
52+
id: os-version
53+
attributes:
54+
label: Operating system version
55+
description: Which version of the operating system are you using on your computer?
56+
validations:
57+
required: true
58+
- type: textarea
59+
id: additional
60+
attributes:
61+
label: Additional context
62+
description: Add any additional information here.
63+
validations:
64+
required: false
65+
- type: checkboxes
66+
id: checklist
67+
attributes:
68+
label: Issue checklist
69+
description: Please double-check that you have done each of the following things before submitting the issue.
70+
options:
71+
- label: I searched for previous requests in [the issue tracker](https://github.com/arduino/arduino-lint/issues?q=)
72+
required: true
73+
- label: I verified the feature was still missing when using the latest version
74+
required: true
75+
- label: My request contains all necessary details
76+
required: true

0 commit comments

Comments
 (0)