From 02546fa0f1a305fef2f8bd00448b2f2a403635d4 Mon Sep 17 00:00:00 2001 From: alichtman Date: Tue, 8 May 2018 01:26:58 -0500 Subject: [PATCH] Added issue templates --- .github/ISSUE_TEMPLATE/Bug_report.md | 72 ++++++++++--------- .github/ISSUE_TEMPLATE/Custom.md | 7 -- .github/ISSUE_TEMPLATE/Feature_request.md | 44 +++++++----- .../ISSUE_TEMPLATE/NEW_ADDITION_TO_LIST.md | 27 +++++++ .../ISSUE_TEMPLATE/REMOVE_ITEM_FROM_LIST.md | 17 +++++ 5 files changed, 108 insertions(+), 59 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/Custom.md create mode 100644 .github/ISSUE_TEMPLATE/NEW_ADDITION_TO_LIST.md create mode 100644 .github/ISSUE_TEMPLATE/REMOVE_ITEM_FROM_LIST.md diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md index 4de26c7..4566cef 100644 --- a/.github/ISSUE_TEMPLATE/Bug_report.md +++ b/.github/ISSUE_TEMPLATE/Bug_report.md @@ -1,35 +1,37 @@ ---- -name: Bug report -about: Create a report to help us improve - ---- - -**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. - -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] - -**Smartphone (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] - -**Additional context** -Add any other context about the problem here. +--- +name: Bug report +about: File a report when something goes wrong so it can get fixed! + +--- + +NOTE: Each discrete (stand-alone) request should be in its own issue. + +**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. + +**Desktop (please complete the following information):** + - OS: [e.g. iOS] + - Browser [e.g. Firefox, Chrome, Safari] + - Version and Build [e.g. 59.0.2 (64-bit)] + +**Smartphone (please complete the following information):** + - Device: [e.g. iPhone6] + - OS: [e.g. iOS8.1] + - Browser [e.g. stock browser, safari] + - Version [e.g. 22] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/Custom.md b/.github/ISSUE_TEMPLATE/Custom.md deleted file mode 100644 index daf862c..0000000 --- a/.github/ISSUE_TEMPLATE/Custom.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -name: Custom issue template -about: Describe this issue template's purpose here. - ---- - - diff --git a/.github/ISSUE_TEMPLATE/Feature_request.md b/.github/ISSUE_TEMPLATE/Feature_request.md index 5384295..fe7e5a7 100644 --- a/.github/ISSUE_TEMPLATE/Feature_request.md +++ b/.github/ISSUE_TEMPLATE/Feature_request.md @@ -1,17 +1,27 @@ ---- -name: Feature request -about: Suggest an idea for this project - ---- - -**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. +--- +name: Feature request +about: Suggest a feature for this project + +--- + +NOTE: Each discrete (stand-alone) request should be in its own issue. + +**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. + +### Issue Checklist + +Put an x in the boxes once you've completed each step. You can also fill these out after creating the issue. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before responding to the issue. + +- [ ] I have checked for other similar issues +- [ ] I have explained why this change is important +- [ ] I have added necessary documentation (if appropriate) diff --git a/.github/ISSUE_TEMPLATE/NEW_ADDITION_TO_LIST.md b/.github/ISSUE_TEMPLATE/NEW_ADDITION_TO_LIST.md new file mode 100644 index 0000000..cca381a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/NEW_ADDITION_TO_LIST.md @@ -0,0 +1,27 @@ +--- +name: Addition to list +about: Suggest an addition to this list. + +--- + +NOTE: Each discrete (stand-alone) request should be in its own issue. + +**Put "Add ____" as Title** + [ ] Done + +**Provide a link to the proposed addition.** +Place link here. + +**Explain why it should be added** +A clear and concise description of why it should be added to this list. + +**Additional context** +Add any other context or screenshots about the feature request here. + +### Issue Checklist + +Put an x in the boxes once you've completed each step. You can also fill these out after creating the issue. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before responding to the issue. + +- [ ] I have checked for other similar issues +- [ ] I have explained why this change is important +- [ ] I have added necessary documentation (if appropriate) diff --git a/.github/ISSUE_TEMPLATE/REMOVE_ITEM_FROM_LIST.md b/.github/ISSUE_TEMPLATE/REMOVE_ITEM_FROM_LIST.md new file mode 100644 index 0000000..447efda --- /dev/null +++ b/.github/ISSUE_TEMPLATE/REMOVE_ITEM_FROM_LIST.md @@ -0,0 +1,17 @@ +--- +name: Removal from list +about: Suggest a removal from this list. + +--- + +NOTE: Each discrete (stand-alone) request should be in its own issue. + +**Put "Remove ____" as Title** + [ ] Done + +**Explain why it should be removed** +A clear and concise description of why it should be added to this list. + +**Additional context** +Add any other context or screenshots about the feature request here. +