diff options
| author |  Daniel Augusto <[email protected]> | 2018-10-06 00:48:03 -0300 |
|---|---|---|
| committer | Daniel Augusto <[email protected]> | 2018-10-06 00:48:03 -0300 |
| commit | 929a46dc6c46df731c275c584b1a0f163bd0a881 (patch) | |
| tree | 36e44b2aeae411f67dd05862d2e2548c7ef01702 | |
| parent | :sparkles: Added bug and feature request templates (diff) | |
:memo: Improved grammar and replaced numbered items.
| -rw-r--r-- | .github/ISSUE_TEMPLATE/bug-report-template.md | 23 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/feature_request.md | 16 |
2 files changed, 16 insertions, 23 deletions
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 <provide here detailed description and, if necessary, screenshots>. +The expected behaviour is [provide a detailed description and, if necessary, screenshots]. ## Actual Behavior -The actual behaviour is <provide here detailed description and, if necessary, screenshots>. +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] |