Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit f36df02

Browse files
committed
Switch to form-based GitHub issue templates
This project provides the contributors with templates for the fundamental categories of issues: - bug report - feature request This is helpful to the maintainers and developers because it establishes a standardized framework for the issues and encourages the contributors to provide the essential information. GitHub's original issue template system is very crude, simply pre-populating the issue description field with the text from the template file. https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-templates The contributor may be confused by being presented with a mass of Markdown and placeholder content where they expected a field to write their issue. They also may find it inconvenient to manuever around the framework content and replace the placeholder content. A far better system is now available with GitHub's recently introduced form-based issue templates: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms The user is now presented with a web form. These may include multi-line input fields that have the same formatting and attachment capabilities as the standard GitHub Issue composer, but also additional elements such as menus and checkboxes. The use of this form-based system should provide a much better experience for the contributors and also result in higher quality issues.
1 parent 753872e commit f36df02

File tree

4 files changed

+139
-52
lines changed

4 files changed

+139
-52
lines changed
Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
name: Bug report
2+
description: Report a problem with the code or documentation in this repository.
3+
labels:
4+
- "type: imperfection"
5+
body:
6+
- type: textarea
7+
id: description
8+
attributes:
9+
label: Describe the problem
10+
validations:
11+
required: true
12+
- type: textarea
13+
id: reproduce
14+
attributes:
15+
label: To reproduce
16+
description: Provide the specific set of steps we can follow to reproduce the problem.
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: expected
21+
attributes:
22+
label: Expected behavior
23+
description: What would you expect to happen after following those instructions?
24+
validations:
25+
required: true
26+
- type: input
27+
id: project-version
28+
attributes:
29+
label: Arduino IDE version
30+
description: |
31+
Which version of the Arduino IDE are you using?
32+
See **Help > About Arduino IDE** in the Arduino IDE menus (**Arduino IDE > About Arduino IDE** on macOS).
33+
This should be the latest [nightly build](https://github.com/arduino/arduino-ide#nightly-builds).
34+
validations:
35+
required: true
36+
- type: dropdown
37+
id: os
38+
attributes:
39+
label: Operating system
40+
description: Which operating system are you using on your computer?
41+
options:
42+
- Windows
43+
- Linux
44+
- macOS
45+
validations:
46+
required: true
47+
- type: input
48+
id: os-version
49+
attributes:
50+
label: Operating system version
51+
description: Which version of the operating system are you using on your computer?
52+
validations:
53+
required: true
54+
- type: textarea
55+
id: additional
56+
attributes:
57+
label: Additional context
58+
description: Add any additional information here.
59+
validations:
60+
required: false
61+
- type: checkboxes
62+
id: checklist
63+
attributes:
64+
label: Issue checklist
65+
description: Please double-check that you have done each of the following things before submitting the issue.
66+
options:
67+
- label: I searched for previous reports in [the issue tracker](https://github.com/arduino/arduino-ide/issues?q=)
68+
required: true
69+
- label: I verified the problem still occurs when using the latest [nightly build](https://github.com/arduino/arduino-ide#nightly-builds)
70+
required: true
71+
- label: My report contains all necessary details
72+
required: true

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 0 additions & 32 deletions
This file was deleted.
Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
name: Feature request
2+
description: Suggest an enhancement to this project.
3+
labels:
4+
- "type: enhancement"
5+
body:
6+
- type: textarea
7+
id: description
8+
attributes:
9+
label: Describe the request
10+
validations:
11+
required: true
12+
- type: textarea
13+
id: current
14+
attributes:
15+
label: Describe the current behavior
16+
description: |
17+
What is the current behavior of the Arduino IDE in relation to your request?
18+
How can we reproduce that behavior?
19+
validations:
20+
required: true
21+
- type: input
22+
id: project-version
23+
attributes:
24+
label: Arduino IDE version
25+
description: |
26+
Which version of the Arduino IDE are you using?
27+
See **Help > About Arduino IDE** in the Arduino IDE menus (**Arduino IDE > About Arduino IDE** on macOS).
28+
This should be the latest [nightly build](https://github.com/arduino/arduino-ide#nightly-builds).
29+
validations:
30+
required: true
31+
- type: dropdown
32+
id: os
33+
attributes:
34+
label: Operating system
35+
description: Which operating system are you using on your computer?
36+
options:
37+
- Windows
38+
- Linux
39+
- macOS
40+
validations:
41+
required: true
42+
- type: input
43+
id: os-version
44+
attributes:
45+
label: Operating system version
46+
description: Which version of the operating system are you using on your computer?
47+
validations:
48+
required: true
49+
- type: textarea
50+
id: additional
51+
attributes:
52+
label: Additional context
53+
description: Add any additional information here.
54+
validations:
55+
required: false
56+
- type: checkboxes
57+
id: checklist
58+
attributes:
59+
label: Issue checklist
60+
description: Please double-check that you have done each of the following things before submitting the issue.
61+
options:
62+
- label: I searched for previous requests in [the issue tracker](https://github.com/arduino/arduino-ide/issues?q=)
63+
required: true
64+
- label: I verified the feature was still missing when using the latest [nightly build](https://github.com/arduino/arduino-ide#nightly-builds)
65+
required: true
66+
- label: My request contains all necessary details
67+
required: true

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 0 additions & 20 deletions
This file was deleted.

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /