From 2aedfb5b0fea74e2036f52da9323cc4f23cf5697 Mon Sep 17 00:00:00 2001 From: Justin Dalrymple Date: Wed, 21 Nov 2018 11:35:43 -0500 Subject: [PATCH] Issue template updates --- .github/ISSUE_TEMPLATE/Bug.md | 17 +++++++++++------ ...{Feature Proposal.md => feature_proposal.md} | 11 ++++++++--- .../{Technical Debt.md => technical_debt.md} | 11 ++++++++--- 3 files changed, 27 insertions(+), 12 deletions(-) rename .github/ISSUE_TEMPLATE/{Feature Proposal.md => feature_proposal.md} (69%) rename .github/ISSUE_TEMPLATE/{Technical Debt.md => technical_debt.md} (74%) diff --git a/.github/ISSUE_TEMPLATE/Bug.md b/.github/ISSUE_TEMPLATE/Bug.md index 260e0692..dc94a748 100644 --- a/.github/ISSUE_TEMPLATE/Bug.md +++ b/.github/ISSUE_TEMPLATE/Bug.md @@ -1,21 +1,26 @@ +--- +name: Bug +about: Create a bug report +--- + Please make sure the new issue you are opening is not a duplicate, and **remove** this notice! ------- +--- -## Description +**Description** *(Brief description of your issue here)* (Paste any relevant logs - please use code blocks (```) to format console output, logs, and code as it's very hard to read otherwise.) -## Steps to reproduce +**Steps to reproduce** *(Tell us how to reproduce this issue. Please provide a working demo, you can use this template as a base)* -## Expected behaviour +**Expected behaviour** *(What is supposed to happen?)* -## Actual behaviour +**Actual behaviour** *(What happens instead?)* -## Possible fixes +**Possible fixes** *(Any possible suggestions on how to fix this problem)* diff --git a/.github/ISSUE_TEMPLATE/Feature Proposal.md b/.github/ISSUE_TEMPLATE/feature_proposal.md similarity index 69% rename from .github/ISSUE_TEMPLATE/Feature Proposal.md rename to .github/ISSUE_TEMPLATE/feature_proposal.md index 11e6cf2d..f4f5a80e 100644 --- a/.github/ISSUE_TEMPLATE/Feature Proposal.md +++ b/.github/ISSUE_TEMPLATE/feature_proposal.md @@ -1,9 +1,14 @@ +--- +name: Feature Proposal +about: Suggest an idea +--- + Please make sure the new issue you are opening is not a duplicate, and **remove** this notice! ------- +--- -## Description +**Description** *(Brief description of the feature)* -## Proposal +**Proposal** *(Outline how you plan to implement this feature if you have one)* diff --git a/.github/ISSUE_TEMPLATE/Technical Debt.md b/.github/ISSUE_TEMPLATE/technical_debt.md similarity index 74% rename from .github/ISSUE_TEMPLATE/Technical Debt.md rename to .github/ISSUE_TEMPLATE/technical_debt.md index 7e96a61d..8b6d368e 100644 --- a/.github/ISSUE_TEMPLATE/Technical Debt.md +++ b/.github/ISSUE_TEMPLATE/technical_debt.md @@ -1,12 +1,17 @@ +--- +name: Technical Debt +about: Suggest an improvement to the codebase +--- + Please make sure the new issue you are opening is not a duplicate, and **remove** this notice! ------- +--- -## Description +**Description** *(Brief description of the technical debt here)* *(Paste any relevant logs - please use code blocks (```) to format console output, logs, and code as it's very hard to read otherwise.)* -## Possible solutions +**Possible solutions** *(Any possible suggestions on how to improve this code)*