Skip to content

Commit bed3b20

Browse files
committed
Add issue templates
A menu of issue categories will be presented when the user begins the issue creation process. The issue will be prefilled with prompts for the specific information needed for each issue type. If none of the issue types are applicable, the user can click the "Open a blank issue" link at the bottom of the issue template chooser page to get the previous issue creation behavior. The default organization level security policy is linked to for people wanting to report a security vulnerability. Links are provided to the Arduino Language Reference, Arduino Forum, and Arduino Developers Mailing list to redirect support requests. References: - https://docs.github.com/en/github/building-a-strong-community/about-issue-and-pull-request-templates - https://docs.github.com/en/github/building-a-strong-community/creating-a-pull-request-template-for-your-repository - https://docs.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
1 parent 2af4a9c commit bed3b20

File tree

6 files changed

+125
-0
lines changed

6 files changed

+125
-0
lines changed

Diff for: .github/ISSUE_TEMPLATE/api-deprecation.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
name: API deprecation
3+
about: Suggest the deprecation of an API component defined by ArduinoCore-API.
4+
title: ""
5+
labels: enhancement
6+
assignees: ""
7+
---
8+
9+
### API component
10+
11+
<!-- Tell us which API component the deprecation applies to. -->
12+
13+
### Description
14+
15+
<!-- A clear and concise description of the suggestion. -->
16+
<!-- What is the reason for the deprecation? -->
17+
18+
### Replacement API component
19+
20+
<!-- What should be used instead of the deprecated API component? -->
21+
<!-- Is this replacement available to all users (e.g., is it provided by the C++ standard version used in major boards platforms)? -->
22+
23+
### Additional information
24+
25+
<!-- Add any other context for the suggestion here. -->

Diff for: .github/ISSUE_TEMPLATE/api-improvement.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: API improvement
3+
about: Suggest an improvement to an existing API component.
4+
title: ""
5+
labels: enhancement
6+
assignees: ""
7+
---
8+
9+
### API component
10+
11+
<!-- Tell us which API component the improvement applies to. -->
12+
13+
### Description
14+
15+
<!-- A clear and concise description of the suggestion. -->
16+
17+
### Is this a breaking change?
18+
19+
<!-- Would this change require any users to change their code? -->
20+
<!-- Would this change require any boards platform authors to change their configuration files or release system? -->
21+
22+
### Additional information
23+
24+
<!-- Add any other context for the request here. -->

Diff for: .github/ISSUE_TEMPLATE/bug_report.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
name: Bug report
3+
about: Report problems with the code in this repository.
4+
title: ""
5+
labels: bug
6+
assignees: ""
7+
---
8+
9+
### Description
10+
11+
<!-- A clear and concise description of the bug. -->
12+
13+
### Environment
14+
15+
- Boards platform name:
16+
- Boards platform version (as shown in Boards Manager):
17+
- ArduinoCore-API version (if you manually installed it):
18+
19+
### Current behavior
20+
21+
<!-- Provide a minimal sketch that demonstrates the issue. -->
22+
23+
### Expected behavior
24+
25+
<!-- Describe what you expect to happen when the demonstration sketch is run. -->
26+
27+
### Additional information
28+
29+
<!-- Add any other context about the problem here. -->

Diff for: .github/ISSUE_TEMPLATE/config.yml

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
contact_links:
2+
- name: Learn about the Arduino language
3+
url: https://www.arduino.cc/reference/en
4+
about: User documentation is available at the Arduino language reference.
5+
- name: Support request
6+
url: https://forum.arduino.cc/
7+
about: We can help you out on the Arduino Forum!
8+
- name: Discuss ArduinoCore-API development
9+
url: https://groups.google.com/a/arduino.cc/g/developers
10+
about: Arduino Developers Mailing List

Diff for: .github/ISSUE_TEMPLATE/new-api-component.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
name: New API component
3+
about: Suggest the addition of a new API component to ArduinoCore-API.
4+
title: ""
5+
labels: enhancement
6+
assignees: ""
7+
---
8+
9+
### Description
10+
11+
<!-- A clear and concise description of the API component you want added. -->
12+
13+
### Additional information
14+
15+
<!-- Add any other context for the request here. -->

Diff for: .github/ISSUE_TEMPLATE/other-enhancement.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: Other enhancement
3+
about:
4+
Suggest an improvement for this project that doesn't fit in the specific categories
5+
above.
6+
title: ""
7+
labels: enhancement
8+
assignees: ""
9+
---
10+
11+
### Description
12+
13+
<!-- A clear and concise description of the enhancement. -->
14+
15+
### Is this a breaking change?
16+
17+
<!-- Would this change require any users to change their code? -->
18+
<!-- Would this change require any boards platform authors to change their configuration files or release system? -->
19+
20+
### Additional information
21+
22+
<!-- Add any other context for the request here. -->

0 commit comments

Comments
 (0)