From a5ccfda20a95e2c5e4bb9f537d16d0c5c1491f73 Mon Sep 17 00:00:00 2001 From: Fletcher Haynes Date: Sun, 30 Dec 2018 14:53:04 -0800 Subject: [PATCH 1/5] Add issue templates This adds issue templates so people can more easily provide everything we need to make something actionable. --- .github/ISSUE_TEMPLATE/bug-report.md | 40 +++++++++++++++++++ .../feature-modification-request.md | 28 +++++++++++++ .github/ISSUE_TEMPLATE/maintenance-request.md | 28 +++++++++++++ .github/ISSUE_TEMPLATE/new-feature-request.md | 24 +++++++++++ 4 files changed, 120 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/feature-modification-request.md create mode 100644 .github/ISSUE_TEMPLATE/maintenance-request.md create mode 100644 .github/ISSUE_TEMPLATE/new-feature-request.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md new file mode 100644 index 0000000000..f3845bc118 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -0,0 +1,40 @@ +--- +name: Bug Report +about: Found a bug? Create a report to help us improve! +title: "[BUG] Brief Description Here" +labels: 'status: needs triage, type: bug' +assignees: '' + +--- + +## Description + +A clear and concise description of what the bug is. + +## Reproduction Steps + +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +## What You Expected to Happen + +A clear and concise description of what you expected to happen. + +## What Actually Happened + +A clear and concise description of what actually happened. + +## Screenshots + +If applicable, add screenshots to help explain your problem. + +## Your Environment + +1. Operating System +2. Operating System Version +3. Version of Amethyst + +## Additional Context +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature-modification-request.md b/.github/ISSUE_TEMPLATE/feature-modification-request.md new file mode 100644 index 0000000000..dc6e37b3b0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-modification-request.md @@ -0,0 +1,28 @@ +--- +name: Feature Modification Request +about: Have a suggestion to make an existing feature better? Let us know! +title: "[FEATURE MODIFICATION] Brief Description Here" +labels: 'status: needs triage, type: modification' +assignees: '' + +--- + +## Feature + +Which feature would you like to modify? + +## Change + +What change would you like to make to it? + +## Reason + +Why do you want to make this change? + +## Impact + +What impact would this change have? Do you think it would impact more features than just the one being modified? + +## Additional Notes + +Anything else relevant to add can go here diff --git a/.github/ISSUE_TEMPLATE/maintenance-request.md b/.github/ISSUE_TEMPLATE/maintenance-request.md new file mode 100644 index 0000000000..2acf58469a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/maintenance-request.md @@ -0,0 +1,28 @@ +--- +name: Maintenance Request +about: See something that isn't quite a bug, but could be made better? Use this! +title: "[MAINTENANCE] Brief Description Here" +labels: 'status: needs triage, type: maintenance' +assignees: '' + +--- + +## Note + +This type of request is for things like `unwrap()`s that snuck into production. They aren't likely to cause problems and aren't really a bug, but should be updated. Other examples include formatting updates, dependency updates, or code simplification. + +## Description + +What do you see that needs to be updated? Include a link to the code if possible. + +## Reason + +Why should this change be made? + +## Impact + +Do you think this change will have a negative impact on anything else? + +## Additional Information + +Any extra info you want to add can go here diff --git a/.github/ISSUE_TEMPLATE/new-feature-request.md b/.github/ISSUE_TEMPLATE/new-feature-request.md new file mode 100644 index 0000000000..bb3f2cb449 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/new-feature-request.md @@ -0,0 +1,24 @@ +--- +name: New Feature Request +about: Suggest a new feature for this project +title: "[NEW FEATURE] Title Goes Here" +labels: 'status: needs triage, type: feature' +assignees: '' + +--- + +## Description + +Please note this is not for modifications to existing features. There is another Issue type for that. This is for proposing something that does not yet exist. + +## What problem does this solve? What need does it fill? +A clear and concise description of what the problem/need is. Ex. I'm frustrated when I lose work due to a lack of auto-save. + +**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. From 253a121f39836a56febddff92ac6124d8a352dd6 Mon Sep 17 00:00:00 2001 From: Fletcher Haynes Date: Mon, 31 Dec 2018 10:38:37 -0800 Subject: [PATCH 2/5] Update bug-report.md --- .github/ISSUE_TEMPLATE/bug-report.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index f3845bc118..cccf8495ca 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -26,9 +26,9 @@ A clear and concise description of what you expected to happen. A clear and concise description of what actually happened. -## Screenshots +## Screenshots and Logs -If applicable, add screenshots to help explain your problem. +If applicable, add screenshots to help explain your problem. Any relevant logs would be helpful as well. ## Your Environment From f7da7de48f33c660f29ef7aa3f697d8b5e1f7605 Mon Sep 17 00:00:00 2001 From: Fletcher Haynes Date: Mon, 31 Dec 2018 10:39:01 -0800 Subject: [PATCH 3/5] Update bug-report.md --- .github/ISSUE_TEMPLATE/bug-report.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index cccf8495ca..4fb9c40ea6 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -1,6 +1,6 @@ --- name: Bug Report -about: Found a bug? Create a report to help us improve! +about: Found a bug? Create a report and help us improve! title: "[BUG] Brief Description Here" labels: 'status: needs triage, type: bug' assignees: '' From 6530887cb482ccf70f5deaecdbc1aa19f93f699a Mon Sep 17 00:00:00 2001 From: Fletcher Haynes Date: Mon, 31 Dec 2018 10:39:40 -0800 Subject: [PATCH 4/5] Update new-feature-request.md --- .github/ISSUE_TEMPLATE/new-feature-request.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/new-feature-request.md b/.github/ISSUE_TEMPLATE/new-feature-request.md index bb3f2cb449..96344b0be9 100644 --- a/.github/ISSUE_TEMPLATE/new-feature-request.md +++ b/.github/ISSUE_TEMPLATE/new-feature-request.md @@ -1,6 +1,6 @@ --- name: New Feature Request -about: Suggest a new feature for this project +about: Have an idea that could improve this project? We want to hear it! title: "[NEW FEATURE] Title Goes Here" labels: 'status: needs triage, type: feature' assignees: '' From 13799ca97b47f38c8f7843b199fcfdff505fc1a6 Mon Sep 17 00:00:00 2001 From: Fletcher Haynes Date: Mon, 31 Dec 2018 10:40:21 -0800 Subject: [PATCH 5/5] Update new-feature-request.md --- .github/ISSUE_TEMPLATE/new-feature-request.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/new-feature-request.md b/.github/ISSUE_TEMPLATE/new-feature-request.md index 96344b0be9..8ddeb982b6 100644 --- a/.github/ISSUE_TEMPLATE/new-feature-request.md +++ b/.github/ISSUE_TEMPLATE/new-feature-request.md @@ -14,11 +14,11 @@ Please note this is not for modifications to existing features. There is another ## What problem does this solve? What need does it fill? A clear and concise description of what the problem/need is. Ex. I'm frustrated when I lose work due to a lack of auto-save. -**Describe the solution you'd like** +## Describe the solution you'd like A clear and concise description of what you want to happen. -**Describe alternatives you've considered** +## 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. +## Additional context +Add any other context, logs, or screenshots about the feature request here.