Skip to content

Add issue templates #138

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 13, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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. -->