mirrors/Atmosphere
1
0
Fork 0
mirror of https://github.com/Atmosphere-NX/Atmosphere.git synced 2024-11-26 22:02:15 +00:00
Code Issues Releases Activity

New issue templates

Browse source 
Uses the new issue templates from here: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates
This commit is contained in:
Bennett Blodinger 2021-09-02 21:28:47 -05:00
parent 165c926135
commit b7826e7c66
4 changed files with 163 additions and 106 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

58
.github/ISSUE_TEMPLATE/bug_report.md vendored
View file

@ -1,58 +0,0 @@
---
name: Bug Report
about: Something doesn't work correctly in Atmosphère.
#assignees:
---
## Bug Report
[ If any section does not apply, replace its contents with "N/A". ]</br>
[ Lines between [ ] (square brackets) should be removed before posting. ]</br>
[ * ]</br>
[ Note: If the bug or crash you encountered is related to; ]</br>
[ - software used to make "backups", ]</br>
[ - software explicitly distributed for piracy, etc ]</br>
[ then contributors will not provide support for your issue and your issue will be closed. ]</br>
### What's the issue you encountered?
[ Describe the issue in detail and what you were doing beforehand. ]</br>
[ Did you make any changes related to Atmosphère itself? ]</br>
[ If so, make sure to include details relating to what exactly you changed. ]</br>
### How can the issue be reproduced?
[ * ]</br>
[ Include a detailed step by step process for recreating your issue. ]</br>
### Crash Report
[ Crash reports can be found under ``/atmosphere/crash_reports``. ]</br>
[ If your issue caused Atmosphère to crash, include the crash report(s) by creating a [gist](https://gist.github.com/) and pasting the link here. ]</br>
[ If you don't include a crash report in instances of crash related issues, we will ask you one to provide one. ]</br>
### System Firmware Version
X.X.X</br>
[ Replace X's with system firmware version at time of crash. ]</br>
[ You can find your firmware version in the Settings -> System, under "System Update". ]</br>
[ If it says "Update Pending", you can clear the pending update by rebooting to Maintenance Mode. ]</br>
### Environment?
- What bootloader (fusèe, hekate, etc) was Atmosphère launched by:
- Official release or unofficial build:
- [ Official release version x.x.x (or) unofficial build ]
- [ If using an unofficial build, include details on where/how you acquired the build. ]
- [ Ex: Self-compilation ]
- [ Ex: Kosmos' distribution of Atmosphère ]
- Do you have additional kips or sysmodules you're loading:
- Homebrew software installed: [ * ]
- EmuMMC or SysNAND:
- [ If using an EmuMMC, include whether it's partition-based or file-based. ]
### Additional context?
- Additional info about your environment:
- [ Any other information relevant to your issue. ]

93
.github/ISSUE_TEMPLATE/bug_report.yml vendored Normal file
View file

@ -0,0 +1,93 @@
name: Bug Report
description: Something doesn't work correctly in Atmosphère.
#assignees:
#labels:
#title:
body:
- type: markdown
attributes:
value: |
If any section does not apply, replace its content with "N/A"
**Note**: If the bug or crash you encountered is related to:
- software used to make "backups"
- software explicitly distributed for piracy, etc
then contributors will not provide support for your issue and your issue will be closed.
- type: textarea
attributes:
label: What's the issue you encountered?
description: |
Describe the issue in detail and what you were doing beforehand.
Did you make any changes related to Atmosphère itself?
If so, make sure to include details relating to what exactly you changed.
validations:
required: true
- type: textarea
attributes:
label: How can the issue be reproduced?
description: Include a detailed step by step process for recreating your issue.
validations:
required: true
- type: input
attributes:
label: Crash Report
description: |
Crash reports can be found under `/atmosphere/crash_reports`.
If your issue caused Atmosphère to crash, include the crash report(s) by creating a [gist](https://gist.github.com/) and pasting the link here.
If your don't include a crash report in instances of crash related issues, we will ask you to provide one.
- type: input
attributes:
label: System Firmware Version
description: |
Replace ×'s with system firmware version at time of crash.
You can find your firmware version in the Settings -> System, under "System Update".
If if says "Update Pending", you can clear the pending update by rebooting to [Maintenance Mode](https://switchbrew.org/wiki/Boot_Modes#Button_combination).
placeholder: ×.×.×
validations:
required: true
- type: markdown
attributes:
value: "## Environment"
- type: dropdown
attributes:
label: What bootloader was Atmosphère launched by
options:
- fusèe
- hekate
- other
validations:
required: true
- type: dropdown
attributes:
label: Release type
options:
- Official release
- Unofficial build
validations:
required: true
- type: textarea
attributes:
label: If using an unofficial build, include details on where/how you acquired the build.
description: |
Ex: Self-compliation
Ex: DeepSea's distribution of Atmosphère
- type: textarea
attributes:
label: Additional kips or sysmodules you're loading
- type: textarea
attributes:
label: Homebrew software installed
- type: dropdown
attributes:
label: NAND type
options:
- EmuNAND - partition-based
- EmuNAND - file-based
- SysNAND
- type: textarea
attributes:
label: Additional context
description: |
Additional info about your environment
Any other information relevant to your issue.

48
.github/ISSUE_TEMPLATE/feature_request.md vendored
View file

@ -1,48 +0,0 @@
---
name: Feature Request
about: Suggest a new feature for Atmosphère.
#assignees:
---
## Feature Request
[ If any section does not apply, replace its contents with "N/A". ]</br>
[ If you do not have the information needed for a section, replace its contents with "Unknown". ]</br>
[ Lines between [ ] (square brackets) are to be removed before posting. ]
[ Please search for existing [feature requests](https://github.com/Atmosphere-NX/Atmosphere/issues?utf8=%E2%9C%93&q=is%3Aissue+label%3A%22features%2Ffeature-request%22) before you make your own request. ]</br>
[ Duplicate requests will be marked as such and you will be referred to the original request. ]
### What feature are you suggesting?
#### Overview:
- [ Include the basic, high-level concepts for this feature here. ]</br>
#### Smaller Details:
- [ These may include specific methods of implementation etc. ]</br>
#### Nature of Request:
[ Remove all that do not apply to your request. ]
- Addition
- [ Ex: Addition of certain original features or features from other community projects. ]
- [ If you are suggesting porting features or including features from other projects, include what license they are distributed under and what, if any libraries those project use. ]
- Change
- Removal
- [Ex: Removal of certain features or implementation due to a specific issue/bug or because of low quality code, etc.]
### What component do you feel this would best fit within?
- [Fusée](https://github.com/Atmosphere-NX/Atmosphere#components)</br>
- Atmosphère's custom bootloader.</br>
- [Exosphère](https://github.com/Atmosphere-NX/Atmosphere#components)</br>
- Fully-featured custom secure monitor.</br>
- [Stratosphère](https://github.com/Atmosphere-NX/Atmosphere#components)</br>
- Custom system modules.</br>
- [**Thermosphère**](https://github.com/Atmosphere-NX/Atmosphere#components)</br>
- Atmosphère's emuNAND implementation.</br>
- [**Troposphère**](https://github.com/Atmosphere-NX/Atmosphere#components)</br>
- Application-level patches to the Horizon OS.</br>
[ Note: **Bolded components are not implemented** or are still at the prototyping phase. ]
### Why would this feature be useful?
[ If this is a feature for an end-user, how does it benefit the end-user? ]</br>
[ If this feature is for developers, what does it add to Atmosphère that did not already exist? ]</br>

70
.github/ISSUE_TEMPLATE/feature_request.yml vendored Normal file
View file

@ -0,0 +1,70 @@
name: Feature Request
description: Suggest a new feature for Atmosphère.
#assignees:
labels: [enhancement]
#title:
body:
- type: markdown
attributes:
value: |
If any section does not apply, replace its contents with "N/A".
If you do not have the information needed for a section, replace its contents with "Unknown".
Please search for existing [feature requests](https://github.com/Atmosphere-NX/Atmosphere/issues?q=label%3Aenhancement) before you make your own request.
Duplicate requests will be marked as such and you will be referred to the original request.
- type: markdown
attributes:
value: "## What feature are you suggesting?"
- type: textarea
attributes:
label: Overview
description: Include the basic, high-level concepts for this feature here.
validations:
required: true
- type: textarea
attributes:
label: Smaller Details
description: These may include specific methods of implementation etc.
validations:
required: true
- type: textarea
attributes:
label: Nature of Request
description: Remove all that do you apply to your request
value: |
Addition
- Ex: Addition of certain original features or features from other community projects.
- If you are suggesting porting features or including features from other projects, include what license they are distributed under and what, if any libraries those projects use.
Change
Removal
- Ex: Removal of certain features or implementation due to a specific issue/bug or because of low quality code, etc.
validations:
required: true
- type: dropdown
attributes:
label: What component do you feel this would best fit within?
description: |
[Fusée](https://github.com/Atmosphere-NX/Atmosphere#components): Atmosphère's custom bootloader.
[Exosphère](https://github.com/Atmosphere-NX/Atmosphere#components): Fully-featured custom secure monitor.
[Stratosphère](https://github.com/Atmosphere-NX/Atmosphere#components): Custom system modules.
[**Thermosphère**](https://github.com/Atmosphere-NX/Atmosphere#components): Atmosphère's emuNAND implementation.
[**Troposphère**](https://github.com/Atmosphere-NX/Atmosphere#components): Application-level patches to the Horizon OS.
Note: **Bolded components are not implemented** or are still at the prototyping phase.
options:
- Fusée
- Exosphère
- Stratosphère
- Thermosphère
- Troposphère
validations:
required: true
- type: textarea
attributes:
label: Why would this feature be useful?
description: |
If this is a feature for an end-user, how does it benefit the end-user?
If this feature is for developers, what does it add to Atmosphère that did not already exist?
validations:
required: true