Skip to content

Commit

Permalink
Merge branch 'develop' of github.com:OpenShock/Firmware into develop
Browse files Browse the repository at this point in the history
  • Loading branch information
redmushie committed Oct 18, 2023
2 parents 8b8a2fc + c1c10c6 commit 10dd46c
Show file tree
Hide file tree
Showing 12 changed files with 474 additions and 132 deletions.
123 changes: 123 additions & 0 deletions .github/ISSUE_TEMPLATE/10-bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
name: 'Bug Report'
description: "Something isn't working as expected."
title: '[Bug] '
labels: ['type: bug', 'status: triage']
projects: ['OpenShock/3']

body:

- type: markdown
attributes:
value: |
# Checklist
- type: checkboxes
id: checklist
attributes:
label: Pre-submission checklist
description: |
To prevent wasting your or our time, please fill out the below checklist before continuing.
Thanks for understanding!
options:
- label: 'I checked that no other Bug Report describing my problem exists.'
required: true
- label: 'I am running the latest stable or prerelease firmware.'
required: true
- label: 'My board is on the [list of maintained boards](https://wiki.openshock.org/hardware/boards/#fully-maintained).'
required: true
- label: 'I accept that this issue may be closed if any of the above are found to be untrue.'
required: true

- type: markdown
attributes:
value: |
# Board & Firmware
- type: input
id: board
attributes:
label: Board
description: What board are you using?
placeholder: 'E.g.: Wemos Lolin S3, Pishock 2023, ..'
validations:
required: True

- type: input
id: firmware-version
attributes:
label: 'Firmware version'
description: Which firmware version did you flash?
placeholder: 'E.g.: 1.2.4, 1.0.0-rc.4, 0.0.0-develop, ..'
validations:
required: true

- type: textarea
id: flashing-method
attributes:
label: 'Flashing method'
description: Briefly describe how you flashed your firmware.
placeholder: |
Examples:
- I used the web flash tool.
- I used the downloaded flash tool.
- I used a different tool, namely: ...
- I ran this command: ...
validations:
required: true

- type: markdown
attributes:
value: |
# What happened?
- type: textarea
id: what-happened
attributes:
label: 'Describe what happened as precisely as possible.'
validations:
required: true

- type: markdown
attributes:
value: |
# What did you expect to happen?
- type: textarea
id: what-did-you-expect
attributes:
label: 'Describe what you expected to happen instead.'
validations:
required: true

- type: markdown
attributes:
value: |
# Steps to reproduce
- type: textarea
id: how-to-reproduce
attributes:
label: 'In as much detail as possible, describe the exact steps you took to make the problem appear.'
description: |
If we can't reproduce the problem, we won't be able to figure out how to fix it either!
Make sure to be as precise as you can.
placeholder: |
For example:
1. Connect to the OpenShock wifi network
2. Visit `http://10.10.10.10/`
3. Click a WiFi network
4. Everything explodes!
validations:
required: true

- type: markdown
attributes:
value: |
# Anything else?
- type: textarea
id: anything-else
attributes:
label: 'Other remarks'
validations:
required: false
51 changes: 51 additions & 0 deletions .github/ISSUE_TEMPLATE/20-feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: 'Feature Request'
description: "Is there a feature you'd really like to see? Request it here."
title: '[Feature] '
labels: ['type: enhancement']
projects: ['OpenShock/3']

body:

- type: markdown
attributes:
value: |
# Checklist
- type: checkboxes
id: checklist
attributes:
label: Pre-submission checklist
description: |
To prevent wasting your or our time, please fill out the below checklist before continuing.
Thanks for understanding!
options:
- label: 'I checked that there is no other Feature Request describing my wish.'
required: true
- label: 'I checked that this feature is, in fact, not supported.'
required: true
- label: 'I accept that this issue may be closed if any of the above are found to be untrue.'
required: true

- type: markdown
attributes:
value: |
# Describe the feature
- type: textarea
id: feature-request
attributes:
label: 'What should be possible that currently is not?'
validations:
required: true

- type: markdown
attributes:
value: |
# Anything else?
- type: textarea
id: anything-else
attributes:
label: 'Other remarks'
validations:
required: false
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/30-question.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: 'Question'
description: "Can't figure something out? Feel free to ask."
title: '[Question] '
labels: ['type: question']
projects: ['OpenShock/3']

body:

- type: markdown
attributes:
value: |
# Question
- type: textarea
id: question
attributes:
label: 'Ask your question!'
placeholder: |
How do I..?
Is it possible to..?
Are you planning to..?
validations:
required: true
83 changes: 83 additions & 0 deletions .github/ISSUE_TEMPLATE/40-request-board.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
name: 'Board Request'
description: "Request that support be added for your board."
title: '[Board Request] '
labels: ['type: board-compatability']
projects: ['OpenShock/3']

body:

- type: markdown
attributes:
value: |
# Checklist
- type: checkboxes
id: checklist
attributes:
label: Pre-submission checklist
description: |
To prevent wasting your or our time, please fill out the below checklist before continuing.
Thanks for understanding!
options:
- label: 'I checked that there is no other open Board Request for this board.'
required: true
- label: 'I checked the [maintained boards list](https://wiki.openshock.org/hardware/boards/#fully-maintained) and this board is indeed not supported.'
required: true
- label: 'I accept that this issue may be closed if any of the above are found to be untrue.'
required: true

- type: markdown
attributes:
value: |
# Board information
- type: input
id: board-name
attributes:
label: Board name
description: The name of the board.
placeholder: 'MyBrand XBoard v3, ...'
validations:
required: true

- type: input
id: board-chip
attributes:
label: Board MCU
description: The MCU the board uses. Leave empty only if you don't know.
placeholder: 'ESP32, ESP32-S3, ...'
validations:
required: false

- type: input
id: board-info-link
attributes:
label: Vendor board link
description: Link to the description page for this board on the vendors' website.
placeholder: 'E.g.: https://www.wemos.cc/en/latest/s3/s3_mini.html'
validations:
required: false

- type: textarea
id: board-purchase-links
attributes:
label: Purchase link(s)
description: Put one or more links from where this board can be acquired.
placeholder: |
Examples:
https://amazon.com/...
https://aliexpress.com/...
validations:
required: true

- type: markdown
attributes:
value: |
# Anything else?
- type: textarea
id: anything-else
attributes:
label: 'Other remarks'
validations:
required: false
Loading

0 comments on commit 10dd46c

Please sign in to comment.