You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
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
0 commit comments