From ba19157f5a1f5b06d486d2b32311c696b058f6a5 Mon Sep 17 00:00:00 2001 From: ryanheise Date: Sat, 18 Apr 2020 00:24:15 +1000 Subject: [PATCH] Update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 44 +++++++++++++++++++ .../ISSUE_TEMPLATE/documentation-request.md | 22 ++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 +++++++++ 3 files changed, 86 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/documentation-request.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..65521de --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,44 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: 0 - Backlog, bug +assignees: ryanheise + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**Minimal reproduction project** +If the example project exhibits the bug, please mention that here, otherwise fork this project and modify the example to reproduce the bug. Provide the link to your repository here. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Error messages** + +``` +If applicable, copy & paste error message here. +``` + +**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. MacOS + version] + - Browser [e.g. chrome, safari + version] + +**Smartphone (please complete the following information):** + - Device: [e.g. iPhone6] + - OS: [e.g. iOS8.1] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/documentation-request.md b/.github/ISSUE_TEMPLATE/documentation-request.md new file mode 100644 index 0000000..72bafc5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation-request.md @@ -0,0 +1,22 @@ +--- +name: Documentation request +about: Suggest an improvement to the documentation +title: '' +labels: 0 - Backlog, documentation +assignees: ryanheise + +--- + +**To which pages does your suggestion apply?** + +- Direct URL 1 +- Direct URL 2 +- ... + +**Quote the sentences(s) from the documentation to be improved (if any)** + +> Insert here. (Skip if you are proposing an entirely new section.) + +**Describe your suggestion** + +... diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..3ff0305 --- /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: 0 - Backlog, enhancement +assignees: ryanheise + +--- + +**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.