From 8d20b3f2a51afc509a82553adc12ed450ea0b55d Mon Sep 17 00:00:00 2001 From: Daniel Augusto Date: Fri, 5 Oct 2018 23:42:42 -0300 Subject: :sparkles: Added bug and feature request templates --- .github/ISSUE_TEMPLATE/bug-report-template.md | 36 +++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 24 ++++++++++++++++++ 2 files changed, 60 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report-template.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md (limited to '.github') diff --git a/.github/ISSUE_TEMPLATE/bug-report-template.md b/.github/ISSUE_TEMPLATE/bug-report-template.md new file mode 100644 index 00000000..bcce2b6d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report-template.md @@ -0,0 +1,36 @@ +--- +name: Bug Report Template +about: A simple bug report template. + +--- + +## Description + +Please, provide here a simple description about the bug. + +## Steps + +### Step 1 +Please, provide here a detailed description about the step 1. + +### Step 2 +Please, provide here a detailed description about the step 2. + +### Step 3 +Please, provide here a detailed description about the step 3. + +## Expected Behavior +The expected behaviour is . + +## Actual Behavior +The actual behaviour is . + +## Environment +- Device Type: (e.g.: Desktop or Mobile) +- Operating System: (e.g.: Microsoft Windows or Ubuntu Linux) + - Version: (e.g.: 10 or 18.04) +- Browser: (e.g.: Mozilla Firefox or Google Chrome) + - Version: (e.g.: 1, 2, 3) + +## Other +Please, provide here additional details that can be helpful. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..30606299 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,24 @@ +--- +name: Feature request +about: A simple feature request template. + +--- + +## Description + +Please, provide here a simple description about the feature request. + +## Reason + +- Reason 1 +- Reason 2 +- Reason 3 + +## Required Changes + +- Change 1 +- Change 2 +- Change 3 + +## Other +Please, provide here additional details that can be helpful. -- cgit v1.2.3 From 929a46dc6c46df731c275c584b1a0f163bd0a881 Mon Sep 17 00:00:00 2001 From: Daniel Augusto Date: Sat, 6 Oct 2018 00:48:03 -0300 Subject: :memo: Improved grammar and replaced numbered items. --- .github/ISSUE_TEMPLATE/bug-report-template.md | 23 ++++++++--------------- .github/ISSUE_TEMPLATE/feature_request.md | 16 ++++++++-------- 2 files changed, 16 insertions(+), 23 deletions(-) (limited to '.github') diff --git a/.github/ISSUE_TEMPLATE/bug-report-template.md b/.github/ISSUE_TEMPLATE/bug-report-template.md index bcce2b6d..6c03fc5a 100644 --- a/.github/ISSUE_TEMPLATE/bug-report-template.md +++ b/.github/ISSUE_TEMPLATE/bug-report-template.md @@ -6,31 +6,24 @@ about: A simple bug report template. ## Description -Please, provide here a simple description about the bug. +[provide a simple description of the bug] -## Steps +## Steps to Reproduce -### Step 1 -Please, provide here a detailed description about the step 1. - -### Step 2 -Please, provide here a detailed description about the step 2. - -### Step 3 -Please, provide here a detailed description about the step 3. +- [replace with a description of a step to reproduce the issue] +- [replace with a description of a step to reproduce the issue] +- [replace with a description of a step to reproduce the issue] ## Expected Behavior -The expected behaviour is . +The expected behaviour is [provide a detailed description and, if necessary, screenshots]. ## Actual Behavior -The actual behaviour is . +The actual behaviour is [provide a detailed description and, if necessary, screenshots]. ## Environment - Device Type: (e.g.: Desktop or Mobile) - Operating System: (e.g.: Microsoft Windows or Ubuntu Linux) - Version: (e.g.: 10 or 18.04) -- Browser: (e.g.: Mozilla Firefox or Google Chrome) - - Version: (e.g.: 1, 2, 3) ## Other -Please, provide here additional details that can be helpful. +[provide any additional details that can be helpful] diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 30606299..f0d1d9c0 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -6,19 +6,19 @@ about: A simple feature request template. ## Description -Please, provide here a simple description about the feature request. +[provide a simple description of the feature request] ## Reason -- Reason 1 -- Reason 2 -- Reason 3 +- [replace with a reason] +- [replace with a reason] +- [replace with a reason] ## Required Changes -- Change 1 -- Change 2 -- Change 3 +- [replace with a change] +- [replace with a change] +- [replace with a change] ## Other -Please, provide here additional details that can be helpful. +[provide any additional details that can be helpful] -- cgit v1.2.3 From 2bbc0af09c2542781eaa87988920c22498fa4825 Mon Sep 17 00:00:00 2001 From: Leon Sandøy Date: Mon, 8 Oct 2018 12:22:16 +0200 Subject: Update feature_request.md slight improvements to the template. --- .github/ISSUE_TEMPLATE/feature_request.md | 21 ++++++++------------- 1 file changed, 8 insertions(+), 13 deletions(-) (limited to '.github') diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index f0d1d9c0..bff367e9 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -4,21 +4,16 @@ about: A simple feature request template. --- -## Description +Provide a simple description of how the feature would work. This should not include technical details, but should instead be a high level description of how the user experience would be when you used this feature. -[provide a simple description of the feature request] +## Implementation details -## Reason +List the changes required for the implementation here. -- [replace with a reason] -- [replace with a reason] -- [replace with a reason] - -## Required Changes - -- [replace with a change] -- [replace with a change] -- [replace with a change] +- [ ] Write the bot command +- [ ] Add the command to our README.md +- [ ] etc. ## Other -[provide any additional details that can be helpful] + +Provide any additional information or clarifications here. -- cgit v1.2.3 From 8556c4498cfb74501c813bd7f583b6218f6f87e2 Mon Sep 17 00:00:00 2001 From: Leon Sandøy Date: Mon, 8 Oct 2018 12:27:58 +0200 Subject: Update feature_request.md --- .github/ISSUE_TEMPLATE/feature_request.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to '.github') diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index bff367e9..04d31a5d 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -14,6 +14,6 @@ List the changes required for the implementation here. - [ ] Add the command to our README.md - [ ] etc. -## Other +## Additional information Provide any additional information or clarifications here. -- cgit v1.2.3