Better issue templates!

This commit is contained in:
TrainDoctor 2019-01-17 19:47:24 -08:00 committed by Michael Scire
parent 9bc45475f4
commit c9c8f64f09
4 changed files with 84 additions and 21 deletions

View file

@ -1,25 +1,56 @@
--- ---
name: Bug Report name: Bug Report
about: Something doesn't work correctly in Atmosphère. about: Something doesn't work correctly in Atmosphère.
#assignees:
--- ---
## Bug Report ## 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? ### 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? ### How can the issue be reproduced?
### Crash report? [ * ]</br>
[ Include a detailed step by step process for recreating your issue. ]</br>
(If a crash report was created under /atmosphere/crash_reports/, please upload it to ### Crash Report
[gist](https://gist.github.com/) and paste the link here.)
[ 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? ### Environment?
- What bootloader (fusee, hekate, etc) was Atmosphère launched by: - What bootloader (fusèe, hekate, etc) was Atmosphère launched by:
- Official release or unofficial build: - Official release or unofficial build:
- Do you have additional kips you're loading: - [ Offical release version x.x.x (or) unofficial build ]
- Additional info about your environment: - [ 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: [ * ]
### Additional context? ### Additional context?
- Additional info about your environment:
- [ Any other information relevant to your issue. ]

View file

@ -1,12 +1,48 @@
--- ---
name: Feature Request name: Feature Request
about: You want to suggest a new feature for Atmosphère. about: Suggest a new feature for Atmosphère.
#assignees:
--- ---
## Feature Request ## 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? ### 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? ### 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>

View file

@ -1,12 +1,7 @@
--- ---
name: Question name: Question
about: Please ask questions in the ReSwitched discord, instead of making issues. about: Please ask questions in the ReSwitched discord, instead of making issues.
--- ---
We would like to use GitHub to keep track of problems/feature requests. We would like to use GitHub to keep track of problems/feature requests.
If you have a question, please join the ReSwitched discord for help. If you have a question, please join the ReSwitched discord for help.
- Discord link: https://discordapp.com/invite/DThbZ7z - Discord link: https://discordapp.com/invite/DThbZ7z

View file

@ -3,6 +3,7 @@
===== =====
![License](https://img.shields.io/badge/License-GPLv2-blue.svg) ![License](https://img.shields.io/badge/License-GPLv2-blue.svg)
[![Chat on Discord](https://camo.githubusercontent.com/b4175720ede4f2621aa066ffbabb70ae30044679/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f636861742d446973636f72642d627269676874677265656e2e737667)](https://discordapp.com/invite/ZdqEhed)
Atmosphère is a work-in-progress customized firmware for the Nintendo Switch. Atmosphère is a work-in-progress customized firmware for the Nintendo Switch.