From 88a5db8d964f059a8519501e934cb01d6586b0dc Mon Sep 17 00:00:00 2001 From: BonfaceKilz Date: Mon, 31 Aug 2020 14:25:56 +0300 Subject: 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. --- .github/ISSUE_TEMPLATE/bug_report.md | 33 ++++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 34 +++++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/user_story.md | 16 +++++++++++++++ 3 files changed, 83 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/user_story.md (limited to '.github/ISSUE_TEMPLATE') 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 -- cgit v1.2.3