From f159a1571704d4c82be7b70ef0d20a1778e4e32b Mon Sep 17 00:00:00 2001 From: Tyler Nguyen Date: Sun, 28 Jun 2020 21:47:52 -0500 Subject: [PATCH] Update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 47 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++++++++ 2 files changed, 67 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..5604dd8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,47 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Appropriate boot and/or debug logs** +Please learn how to debug, it will help you help yourself AND help others help you. + +**If you do cannot provide boot and/or debug logs, please provide a ZIP of your EFI** +Make sure to remove your sensitive SMBIOS info before sharing. + +Finally, an example of a **bad** issue: +``` +My keyboard does not work. Can you please help? +``` + +Example of a **good** issue: +``` +My keyboard does not work. +I have applied the appropriate patches according to your docs as followed: +`ssdt-keyboard1.aml` +`voodoo-keyboard` + +Here are my boot logs: + +Here is my EFI: +``` diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..bbcbbe7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here.