diff options
author | BonfaceKilz | 2021-03-25 13:57:36 +0300 |
---|---|---|
committer | BonfaceKilz | 2021-05-08 19:19:47 +0300 |
commit | ae9ef7338815666721141efc352601e255f0f655 (patch) | |
tree | 54e151c0ae0fea13ca19b3cc41662ef473dc3975 /.github | |
parent | 7b94f989bcfbf6543bfa628422331adfa3d5daac (diff) | |
download | genenetwork3-ae9ef7338815666721141efc352601e255f0f655.tar.gz |
Add issue and PR templates
Diffstat (limited to '.github')
-rw-r--r-- | .github/ISSUE_TEMPLATE/bug_report.md | 28 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/feature_request.md | 30 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/user_story.md | 12 | ||||
-rw-r--r-- | .github/PULL_REQUEST_TEMPLATE.md | 17 |
4 files changed, 87 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..af60c29 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,28 @@ +--- +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] --> +<!-- - Guix Version (optional) --> +<!-- - [Anything else you think is relevant] --> + +**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 0000000..813974c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,30 @@ +--- +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. --> +<!-- Example: 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) +<!-- Example: --> +<!-- 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 0000000..d46976b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/user_story.md @@ -0,0 +1,12 @@ +--- +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 0000000..926b054 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,17 @@ +#### 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 --> |