aboutsummaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
authorBonfaceKilz2020-08-31 14:25:56 +0300
committerBonfaceKilz2020-08-31 14:25:56 +0300
commit88a5db8d964f059a8519501e934cb01d6586b0dc (patch)
tree269e10f82cc9e305884a24691c2613b86a711ce0 /.github
parentd2bb95c5e169f1a616ebbea75bbe15b788b0fe70 (diff)
downloadgenenetwork2-88a5db8d964f059a8519501e934cb01d6586b0dc.tar.gz
Add github templates for filing bugs, user stories/ features and PRs
* .github/ISSUE_TEMPLATE/bug_report.md : Add template for filing bug reports. * .github/ISSUE_TEMPLATE/feature_request.md: Add template for filing a feature. * .github/ISSUE_TEMPLATE/user_story.md: Add a template for creating a user story for a feature. * .github/PULL_REQUEST_TEMPLATE.md: Add a template for filing a PR.
Diffstat (limited to '.github')
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.md33
-rw-r--r--.github/ISSUE_TEMPLATE/feature_request.md34
-rw-r--r--.github/ISSUE_TEMPLATE/user_story.md16
-rw-r--r--.github/PULL_REQUEST_TEMPLATE.md11
4 files changed, 94 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 00000000..789d6a57
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,33 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: '[Bug] Bug Title'
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+
+Steps to reproduce the behavior
+
+**Expected behavior**
+
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+
+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]
+
+**Additional context**
+
+Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 00000000..254754c6
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,34 @@
+---
+name: Feature request
+about: Suggest a new feature for this project(Very Specific)
+title: '[Feature] My-cool-feature'
+labels: ''
+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 [...]
+
+## Describe the solution you'd like
+
+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.
+
+## User Stories (optional)
+
+As a _[role or persona]_, I want _[goal/ need]_ so that _[why]_
+
+**Feature:** _[Brief description of feature]_
+
+_[Any additional descriptions on feature]_
+
+**Scenario:** Please use _[Gherkin](https://cucumber.io/docs/gherkin/reference/)_ here
+
+## Additional context
+
+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
new file mode 100644
index 00000000..2682fc98
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/user_story.md
@@ -0,0 +1,16 @@
+---
+name: User Story
+about: Suggest an idea for this project
+title: ['Feature] My-cool-new-feature'
+labels: ''
+assignees: ''
+
+---
+
+As a _[role or persona]_, I want _[goal/ need]_ so that _[why]_
+
+**Feature:** _[Brief description of feature]_
+
+_[Any additional descriptions on feature]_
+
+**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
new file mode 100644
index 00000000..223e24ef
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,11 @@
+#### Description
+
+#### How should this be tested?
+
+#### Any background context you want to provide?
+
+#### What are the relevant pivotal tracker stories?
+
+#### Screenshots (if appropriate)
+
+#### Questions