Skip to content

Commit

Permalink
Merge pull request #138 from per1234/issue-template
Browse files Browse the repository at this point in the history
Add issue templates
  • Loading branch information
aentinger authored Sep 13, 2023
2 parents bbce6f6 + bed3b20 commit 606c586
Show file tree
Hide file tree
Showing 6 changed files with 125 additions and 0 deletions.
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/api-deprecation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
name: API deprecation
about: Suggest the deprecation of an API component defined by ArduinoCore-API.
title: ""
labels: enhancement
assignees: ""
---

### API component

<!-- Tell us which API component the deprecation applies to. -->

### Description

<!-- A clear and concise description of the suggestion. -->
<!-- What is the reason for the deprecation? -->

### Replacement API component

<!-- What should be used instead of the deprecated API component? -->
<!-- Is this replacement available to all users (e.g., is it provided by the C++ standard version used in major boards platforms)? -->

### Additional information

<!-- Add any other context for the suggestion here. -->
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/api-improvement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: API improvement
about: Suggest an improvement to an existing API component.
title: ""
labels: enhancement
assignees: ""
---

### API component

<!-- Tell us which API component the improvement applies to. -->

### Description

<!-- A clear and concise description of the suggestion. -->

### Is this a breaking change?

<!-- Would this change require any users to change their code? -->
<!-- Would this change require any boards platform authors to change their configuration files or release system? -->

### Additional information

<!-- Add any other context for the request here. -->
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
name: Bug report
about: Report problems with the code in this repository.
title: ""
labels: bug
assignees: ""
---

### Description

<!-- A clear and concise description of the bug. -->

### Environment

- Boards platform name:
- Boards platform version (as shown in Boards Manager):
- ArduinoCore-API version (if you manually installed it):

### Current behavior

<!-- Provide a minimal sketch that demonstrates the issue. -->

### Expected behavior

<!-- Describe what you expect to happen when the demonstration sketch is run. -->

### Additional information

<!-- Add any other context about the problem here. -->
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
contact_links:
- name: Learn about the Arduino language
url: https://www.arduino.cc/reference/en
about: User documentation is available at the Arduino language reference.
- name: Support request
url: https://forum.arduino.cc/
about: We can help you out on the Arduino Forum!
- name: Discuss ArduinoCore-API development
url: https://groups.google.com/a/arduino.cc/g/developers
about: Arduino Developers Mailing List
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/new-api-component.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
name: New API component
about: Suggest the addition of a new API component to ArduinoCore-API.
title: ""
labels: enhancement
assignees: ""
---

### Description

<!-- A clear and concise description of the API component you want added. -->

### Additional information

<!-- Add any other context for the request here. -->
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/other-enhancement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: Other enhancement
about:
Suggest an improvement for this project that doesn't fit in the specific categories
above.
title: ""
labels: enhancement
assignees: ""
---

### Description

<!-- A clear and concise description of the enhancement. -->

### Is this a breaking change?

<!-- Would this change require any users to change their code? -->
<!-- Would this change require any boards platform authors to change their configuration files or release system? -->

### Additional information

<!-- Add any other context for the request here. -->

0 comments on commit 606c586

Please sign in to comment.