diff options
Diffstat (limited to '.github')
| -rw-r--r-- | .github/ISSUE_TEMPLATE/bug_report.md | 16 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/feature_request.md | 23 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/user_story.md | 8 | ||||
| -rw-r--r-- | .github/PULL_REQUEST_TEMPLATE.md | 9 |
4 files changed, 36 insertions, 20 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 7d7e34a5..48bad39b 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -9,26 +9,26 @@ assignees: '' **Describe the bug** -A clear and concise description of what the bug is. +<!-- A clear and concise description of what the bug is. --> **To Reproduce** -Steps to reproduce the behavior +<!-- Steps to reproduce the behavior --> **Expected behavior** -A clear and concise description of what you expected to happen. +<!-- A clear and concise description of what you expected to happen. --> **Screenshots** -If applicable, add screenshots to help explain your problem. +<!-- If applicable, add screenshots to help explain your problem. --> **Environment setup (please complete the following information):** -- OS: [e.g. Linux] -- Guix Version (optional) -- [Anything else you think is relevant] +<!-- - OS: [e.g. Linux] --> +<!-- - Guix Version (optional) --> +<!-- - [Anything else you think is relevant] --> **Additional context** -Add any other context about the problem here. +<!-- Add any other context about the problem here. --> diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 254754c6..eb6c3e4b 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -9,26 +9,33 @@ assignees: '' ## 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 [...] +<!-- A clear and concise description of what the problem is. --> + +<!-- Example: I'm always frustrated when [...] --> ## Describe the solution you'd like -A clear and concise description of what you want to happen. +<!-- 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. +<!-- A clear and concise description of any alternative solutions or features you've considered. --> ## User Stories (optional) -As a _[role or persona]_, I want _[goal/ need]_ so that _[why]_ +<!-- Example: --> + +<!-- As a _[role or persona]_, I want _[goal/ need]_ so that _[why]_ --> + +<!-- **Feature:** _[Brief description of feature]_ --> -**Feature:** _[Brief description of feature]_ +<!-- _[Any additional descriptions on feature]_ --> -_[Any additional descriptions on feature]_ +<!-- **Scenario:** -**Scenario:** Please use _[Gherkin](https://cucumber.io/docs/gherkin/reference/)_ here +Please use _[Gherkin](https://cucumber.io/docs/gherkin/reference/)_ +here --> ## Additional context -Add any other context or screenshots about the feature request here. +<!-- Add any other context or screenshots about the feature request here. --> diff --git a/.github/ISSUE_TEMPLATE/user_story.md b/.github/ISSUE_TEMPLATE/user_story.md index 2682fc98..52ae775d 100644 --- a/.github/ISSUE_TEMPLATE/user_story.md +++ b/.github/ISSUE_TEMPLATE/user_story.md @@ -7,10 +7,10 @@ assignees: '' --- -As a _[role or persona]_, I want _[goal/ need]_ so that _[why]_ +<!-- As a _[role or persona]_, I want _[goal/ need]_ so that _[why]_ --> -**Feature:** _[Brief description of feature]_ +<!-- **Feature:** _[Brief description of feature]_ --> -_[Any additional descriptions on feature]_ +<!-- _[Any additional descriptions on feature]_ --> -**Scenario:** Please use _[Gherkin](https://cucumber.io/docs/gherkin/reference/)_ here +<!-- **Scenario:** Please use _[Gherkin](https://cucumber.io/docs/gherkin/reference/)_ here --> diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 223e24ef..f3371183 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,11 +1,20 @@ #### Description +<!--Brief description of the PR. What does this PR do? --> #### How should this be tested? +<!-- What should you do to test this PR? Is there any manual quality +assurance checks that should be done. What are the expectations --> #### Any background context you want to provide? +<!-- Anything the reviewer should be aware of ahead of testing --> + #### What are the relevant pivotal tracker stories? +<!-- Does this PR track anything anywhere? --> + #### Screenshots (if appropriate) #### Questions + +<!-- Are there any questions for the reviewer --> |