Browse Source

Comment out instructions in issue templates

master
Bonface Munyoki 12 months ago
parent
commit
4f8543ac27
Signed by: bonfacemunyoki GPG Key ID: F5BBAE1E0392253F
  1. 20
      .github/ISSUE_TEMPLATE/bug_report.md
  2. 20
      .github/ISSUE_TEMPLATE/feature_request.md
  3. 8
      .github/ISSUE_TEMPLATE/user_story.md

20
.github/ISSUE_TEMPLATE/bug_report.md

@ -8,20 +8,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]
- Racket Version [e.g. v7.6]
<!-- - OS: [e.g. Linux] -->
<!-- - Racket Version [e.g. v7.6] -->
**Additional context**
Add any other context about the problem here.
<!-- Add any other context about the problem here. -->

20
.github/ISSUE_TEMPLATE/feature_request.md

@ -8,23 +8,27 @@ 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. Ex. 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]_
<!-- 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 -->
## Additional context
Add any other context or screenshots about the feature request here.
<!-- Add any other context or screenshots about the feature request here. -->

8
.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 -->
Loading…
Cancel
Save