Skip to content
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

improve on the issue templates #880

Merged
merged 1 commit into from
Mar 5, 2024
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
47 changes: 23 additions & 24 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,35 @@
---
name: Feature request
about: Suggest an idea for this project
name: Feature Request
about: Suggest an idea for this project.
title: ''
labels: ''
labels: ['enhancement']
assignees: ''

---

### Have you checked the GP2040-CE documentation [HERE](https://gp2040-ce.info/) to confirm this feature doesn't already exist?
> Please read these quoted sections before submitting, and remove them (including this one) when you have provided what
> is asked, in order to make addressing the issue easier for everyone. Thank you!
>
> Be sure to:
> * Check the documentation [HERE](https://gp2040-ce.info/) to answer many questions on firmware capabilities and usage.
> * Make sure that your idea has not already been filed [HERE](https://github.com/OpenStickCommunity/GP2040-CE/issues).
> * Confirm the feature does not exist in the latest version of the firmware, found
[HERE](https://github.com/OpenStickCommunity/GP2040-CE/releases).

Yes/No
### Problem

### Which problem is this feature request solving?
> Which problem is this feature request solving?
>
> Provide a clear and concise description of what the problem is. For example, "I'm always frustrated when..."

Provide a clear and concise description of what the problem is. For example, "I'm always frustrated when..."
### Solution

> Describe the solution you would like to see
>
> Provide a clear and concise description of what you want to happen. Let us know about other solutions you've tried or
> researched.

### Describe the solution you would like to see
### Do you plan to work on this feature yourself?

Provide a clear and concise description of what you want to happen.


### Describe alternatives you've considered

Let us know about other solutions you've tried or researched.


### Can you submit a pull request?

Yes/No.


### Are you planning on working on this feature yourself?

Yes/No.
> Beyond a simple yes or no, we are also willing to help with partial solutions or to refine a proof of concept, if you
> are able to contribute.
14 changes: 0 additions & 14 deletions .github/ISSUE_TEMPLATE/general-questions.md

This file was deleted.

47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/hardware-bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
name: Hardware Bug Report
about: Report an issue with supported hardware running GP2040-CE.
title: ''
labels: ['bug']
assignees: ''

---

> Please read these quoted sections before submitting, and remove them (including this one) when you have provided what
> is asked, in order to make addressing the issue easier for everyone. Thank you!
>
> Be sure to:
> * Check the documentation [HERE](https://gp2040-ce.info/) to answer many questions on hardware requirements and usage.
> * Make sure that your issue has not already been filed [HERE](https://github.com/OpenStickCommunity/GP2040-CE/issues).

### Expected Behavior

> Please describe the behaviour you are expecting.

### Current Behavior

> What is the current behaviour? If this is something that worked in the past, be sure to include the conditions in
> which it did.

### Context

> Please provide all relevant information about your setup. This is important in case the issue is not reproducible
> except under certain conditions. Important elements include:
>
> * Name of device
> * Link to where you purchased the device
> * Firmware version
> * Available schematics, designs, etc., especially for custom hardware
> * Similar hardware (e.g. if it has the same GPIO-to-button assignments as a Pico)

### Steps to Reproduce

> Please provide detailed steps for reproducing the issue.
>
> 1. Step 1
> 2. Step 2
> 3. ETC...

### Screenshots & Files

> Please include any relevant screenshots or files here, including photos of the front and back of the board.
66 changes: 33 additions & 33 deletions .github/ISSUE_TEMPLATE/issue---bug-report.md
Original file line number Diff line number Diff line change
@@ -1,52 +1,52 @@
---
name: Issue / Bug report
about: Create a report to help us improve
name: Firmware Bug Report
about: Report an issue with the GP2040-CE firmware.
title: ''
labels: ''
labels: ['bug']
assignees: ''

---

### Prerequisites

Please check the following before posting an issue / bug report.

- [ ] I am running the latest version of the firmware found [HERE](https://github.com/OpenStickCommunity/GP2040-CE/releases)
- [ ] I have checked the documentation [HERE](https://gp2040-ce.info/) and found no answer
- [ ] I checked to make sure that this issue has not already been filed [HERE](https://github.com/OpenStickCommunity/GP2040-CE/issues)
- [ ] I am reporting the issue to the correct repository

### Context

Please provide all relevant information about your setup. This is important in case the issue is not reproducible except for under certain conditions.

* Firmware Version:
* Name of device:
* Link to where you purchased the device:
* Is this a custom build?:
* Operating System:
* Browser:

> Please read these quoted sections before submitting, and remove them (including this one) when you have provided what
> is asked, in order to make addressing the issue easier for everyone. Thank you!
>
> Be sure to:
> * Check the documentation [HERE](https://gp2040-ce.info/) to answer many questions on firmware capabilities and usage.
> * Make sure that your issue has not already been filed [HERE](https://github.com/OpenStickCommunity/GP2040-CE/issues).
> * Confirm your issue exists on the latest version of the firmware, found
[HERE](https://github.com/OpenStickCommunity/GP2040-CE/releases).

### Expected Behavior

Please describe the behaviour you are expecting.

> Please describe the behaviour you are expecting.

### Current Behavior

What is the current behaviour?

> What is the current behaviour? If this is something that worked in the past, be sure to include the conditions in
> which it did (prior version of the firmware, a different GP2040-CE device where it works, etc.).

### Steps to Reproduce
### Context

Please provide detailed steps for reproducing the issue.
> Please provide all relevant information about your setup. This is important in case the issue is not reproducible
> except under certain conditions. Important elements include:
>
> * Firmware version
> * Name of device
> * Link to where you purchased the device
>
> If your issue is with the web configurator, also include:
>
> * Operating System
> * Browser

1. Step 1
2. Step 2
3. ETC...
### Steps to Reproduce

> Please provide detailed steps for reproducing the issue.
>
> 1. Step 1
> 2. Step 2
> 3. ETC...

### Screenshots & Files

Please include any relevant screenshots or files here. If you are having issues with a board please include images of the front and back of the board.
> Please include any relevant screenshots, photos/recordings, or files here.