Skip to content

Commit 64c4982

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 1c2d8e8 commit 64c4982

File tree

5 files changed

+95
-14
lines changed

5 files changed

+95
-14
lines changed

.github/ISSUE_TEMPLATE/bug-report.md

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

.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Source: https://github.com/arduino/tooling-project-assets/blob/main/issue-templates/forms/general/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: textarea
30+
id: additional
31+
attributes:
32+
label: Additional context
33+
description: Add any additional information here.
34+
validations:
35+
required: false
36+
- type: checkboxes
37+
id: checklist
38+
attributes:
39+
label: Issue checklist
40+
description: Please double-check that you have done each of the following things before submitting the issue.
41+
options:
42+
- label: I searched for previous reports in [the issue tracker](https://github.com/arduino/libraries-repository-engine/issues?q=)
43+
required: true
44+
- label: My report contains all necessary details
45+
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +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
15
contact_links:
6+
- name: Learn about using this project
7+
url: https://github.com/arduino/libraries-repository-engine#readme
8+
about: Detailed usage documentation is available here.
29
- name: Learn about the Arduino Library Manager indexer
310
url: https://github.com/arduino/library-registry/blob/main/FAQ.md#arduino-library-manager-faq
411
about: Frequently asked questions about the Library Manager indexer.
512
- name: Support request
613
url: https://forum.arduino.cc/
714
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

.github/ISSUE_TEMPLATE/feature-request.md

Lines changed: 0 additions & 7 deletions
This file was deleted.
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Source: https://github.com/arduino/tooling-project-assets/blob/main/issue-templates/forms/general/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 libraries-repository-engine in relation to your request?
21+
How can we reproduce that behavior?
22+
validations:
23+
required: true
24+
- type: textarea
25+
id: additional
26+
attributes:
27+
label: Additional context
28+
description: Add any additional information here.
29+
validations:
30+
required: false
31+
- type: checkboxes
32+
id: checklist
33+
attributes:
34+
label: Issue checklist
35+
description: Please double-check that you have done each of the following things before submitting the issue.
36+
options:
37+
- label: I searched for previous requests in [the issue tracker](https://github.com/arduino/libraries-repository-engine/issues?q=)
38+
required: true
39+
- label: My request contains all necessary details
40+
required: true

0 commit comments

Comments
 (0)