Skip to content

Commit 9415c4d

Browse files
committed
Use form-based issue templates
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.
1 parent ac00b56 commit 9415c4d

File tree

4 files changed

+196
-26
lines changed

4 files changed

+196
-26
lines changed

.github/ISSUE_TEMPLATE/bug-report.yml

+92
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
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: 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: Arduino Create Agent version
33+
description: |
34+
Which version of Arduino Create Agent are you using?
35+
_This should be the most recent version available._
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: input
59+
id: browser
60+
attributes:
61+
label: Browser
62+
description: |
63+
Which web browser(s) are you using on your computer?
64+
(e.g., Chrome, Safari)
65+
validations:
66+
required: true
67+
- type: input
68+
id: browser-version
69+
attributes:
70+
label: Browser version
71+
description: Which version of the web browser are you using on your computer?
72+
validations:
73+
required: true
74+
- type: textarea
75+
id: additional
76+
attributes:
77+
label: Additional context
78+
description: Add any additional information here.
79+
validations:
80+
required: false
81+
- type: checkboxes
82+
id: checklist
83+
attributes:
84+
label: Issue checklist
85+
description: Please double-check that you have done each of the following things before submitting the issue.
86+
options:
87+
- label: I searched for previous reports in [the issue tracker](https://github.com/arduino/arduino-create-agent/issues?q=)
88+
required: true
89+
- label: I verified the problem still occurs when using the latest version
90+
required: true
91+
- label: My report contains all necessary details
92+
required: true

.github/ISSUE_TEMPLATE/bug_report.md

-26
This file was deleted.

.github/ISSUE_TEMPLATE/config.yml

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
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: true
5+
contact_links:
6+
- name: Install Arduino Create Agent
7+
url: https://create.arduino.cc/getting-started/plugin/welcome
8+
about: This guided installer provides easy installation.
9+
- name: Learn about using this project
10+
url: https://github.com/arduino/arduino-create-agent#readme
11+
about: Detailed usage documentation is available here.
12+
- name: Support request
13+
url: https://forum.arduino.cc/c/software/editor/134
14+
about: We can help you out on the Arduino Forum!
15+
- name: Discuss development work on the project
16+
url: https://groups.google.com/a/arduino.cc/g/developers
17+
about: Arduino Developers Mailing List
+87
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
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: 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 Arduino Create Agent 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: Arduino Create Agent version
28+
description: |
29+
Which version of Arduino Create Agent are you using?
30+
_This should be the most recent version available._
31+
validations:
32+
required: true
33+
- type: dropdown
34+
id: os
35+
attributes:
36+
label: Operating system
37+
description: Which operating system(s) are you using on your computer?
38+
multiple: true
39+
options:
40+
- Windows
41+
- Linux
42+
- macOS
43+
- N/A
44+
validations:
45+
required: true
46+
- type: input
47+
id: os-version
48+
attributes:
49+
label: Operating system version
50+
description: Which version of the operating system are you using on your computer?
51+
validations:
52+
required: true
53+
- type: input
54+
id: browser
55+
attributes:
56+
label: Browser
57+
description: |
58+
Which web browser(s) are you using on your computer?
59+
(e.g., Chrome, Safari)
60+
validations:
61+
required: true
62+
- type: input
63+
id: browser-version
64+
attributes:
65+
label: Browser version
66+
description: Which version of the web browser are you using on your computer?
67+
validations:
68+
required: true
69+
- type: textarea
70+
id: additional
71+
attributes:
72+
label: Additional context
73+
description: Add any additional information here.
74+
validations:
75+
required: false
76+
- type: checkboxes
77+
id: checklist
78+
attributes:
79+
label: Issue checklist
80+
description: Please double-check that you have done each of the following things before submitting the issue.
81+
options:
82+
- label: I searched for previous requests in [the issue tracker](https://github.com/arduino/arduino-create-agent/issues?q=)
83+
required: true
84+
- label: I verified the feature was still missing when using the latest version
85+
required: true
86+
- label: My request contains all necessary details
87+
required: true

0 commit comments

Comments
 (0)