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
[skip changelog] Use form-based issue templates (#1729)
High quality feedback via GitHub issues is a very valuable contribution to the project. It is important to make the
issue creation and management process as efficient as possible for the contributors, maintainers, and developers.
Issue templates are helpful to the maintainers and developers because it establishes a standardized framework for the
issues and encourages the contributors to provide the essential information.
The contributor is now presented with a web form when creating an issue. This consists of multi-line input fields that
have the same formatting, preview, and attachment capabilities as the standard GitHub Issue composer, in addition to
menus and checkboxes where appropriate.
The use of this form-based system should provide a much better experience for the contributors and also result in higher
quality issues by establishing a standardized framework for the issues and encouraging contributors to provide the
essential information.
A template chooser allows the contributor to select the appropriate template type, redirects support requests to the
appropriate communication channels via "Contact Links", and provides a prominent link to security policy to guide any
vulnerability disclosures.
The clear separation of the types of issues encourages the reporter to fit their report into a specific issue category,
resulting in more clarity. Automatic labeling according to template choice allows the reporter to do the initial
classification.
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-cli/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 CLI 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 CLI version
32
+
description: |
33
+
Which version of Arduino CLI are you using?
34
+
(output of `arduino-cli version`)
35
+
_This should be the [nightly build](https://arduino.github.io/arduino-cli/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-cli/issues?q=)
72
+
required: true
73
+
- label: I verified the feature was still missing when using the [nightly build](https://arduino.github.io/arduino-cli/dev/installation/#nightly-builds)
74
+
required: true
75
+
- label: My request contains all necessary details
0 commit comments