From c9c8f64f09ccfcf478b919f9e4601b764573410a Mon Sep 17 00:00:00 2001 From: TrainDoctor Date: Thu, 17 Jan 2019 19:47:24 -0800 Subject: [PATCH] Better issue templates! --- .github/ISSUE_TEMPLATE/bug_report.md | 47 +++++++++++++++++++---- .github/ISSUE_TEMPLATE/feature_request.md | 42 ++++++++++++++++++-- .github/ISSUE_TEMPLATE/question.md | 15 +++----- README.md | 1 + 4 files changed, 84 insertions(+), 21 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 4b4dfad1e..50084ce85 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,25 +1,56 @@ --- 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". ]
+[ Lines between [ ] (square brackets) should be removed before posting. ]
+ +[ * ]
+[ 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. ]
+ ### What's the issue you encountered? +[ 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. ]
+ ### How can the issue be reproduced? -### Crash report? +[ * ]
+[ Include a detailed step by step process for recreating your issue. ]
-(If a crash report was created under /atmosphere/crash_reports/, please upload it to -[gist](https://gist.github.com/) and paste the link here.) +### Crash Report + +[ 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 you don't include a crash report in instances of crash related issues, we will ask you one to provide one. ]
+ +### System Firmware Version + +X.X.X
+[ Replace X's with system firmware version at time of crash. ]
+[ You can find your firmware version in the Settings -> System, under "System Update". ]
+[ If it says "Update Pending", you can clear the pending update by rebooting to Maintenance Mode. ]
### Environment? -- What bootloader (fusee, hekate, etc) was Atmosphère launched by: -- Official release or unofficial build: -- Do you have additional kips you're loading: -- Additional info about your environment: +- What bootloader (fusèe, hekate, etc) was Atmosphère launched by: +- Official release or unofficial build: + - [ Offical 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: [ * ] ### Additional context? + +- Additional info about your environment: +- [ Any other information relevant to your issue. ] diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 3b93d9d25..61a25494c 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,12 +1,48 @@ --- 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 +[ 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". ]
+[ 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. ]
+[ 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. ]
+ +#### Smaller Details: +- [ These may include specific methods of implementation etc. ]
+ +#### 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)
+ - 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. ] ### Why would this feature be useful? - +[ 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? ]
diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md index 6cc1915b9..21e69bd4e 100644 --- a/.github/ISSUE_TEMPLATE/question.md +++ b/.github/ISSUE_TEMPLATE/question.md @@ -1,12 +1,7 @@ --- name: Question -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. - -If you have a question, please join the ReSwitched discord for help. - -- Discord link: https://discordapp.com/invite/DThbZ7z - +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. +If you have a question, please join the ReSwitched discord for help. +- Discord link: https://discordapp.com/invite/DThbZ7z diff --git a/README.md b/README.md index 8059286e6..85f15e3de 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,7 @@ ===== ![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.