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/PULL_REQUEST_TEMPLATE.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md (limited to '.github/PULL_REQUEST_TEMPLATE.md') 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 -- cgit v1.2.3 From bd8c764f49703ecc5cf25153144ad439c1ca2442 Mon Sep 17 00:00:00 2001 From: BonfaceKilz Date: Tue, 3 Nov 2020 22:08:59 +0300 Subject: Update issue and PR templates * .github/ISSUE_TEMPLATE/bug_report.md: Provide explanations in commented out blocks. * .github/ISSUE_TEMPLATE/feature_request.md: Ditto. * .github/PULL_REQUEST_TEMPLATE.md: Ditto. * .github/ISSUE_TEMPLATE/user_story.md: Ditto. --- .github/ISSUE_TEMPLATE/bug_report.md | 16 ++++++++-------- .github/ISSUE_TEMPLATE/feature_request.md | 23 +++++++++++++++-------- .github/ISSUE_TEMPLATE/user_story.md | 8 ++++---- .github/PULL_REQUEST_TEMPLATE.md | 9 +++++++++ 4 files changed, 36 insertions(+), 20 deletions(-) (limited to '.github/PULL_REQUEST_TEMPLATE.md') 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. + **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 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 [...] + + + ## 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]_ + ## 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 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]_ + -**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 index 223e24ef..f3371183 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,11 +1,20 @@ #### Description + #### How should this be tested? + #### Any background context you want to provide? + + #### What are the relevant pivotal tracker stories? + + #### Screenshots (if appropriate) #### Questions + + -- cgit v1.2.3 From 8ed5d0e89cead10b03e5660c8eb87cf58a173436 Mon Sep 17 00:00:00 2001 From: BonfaceKilz Date: Mon, 18 Jan 2021 11:20:02 +0300 Subject: Remove extra newlines in PR and issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 6 ------ .github/ISSUE_TEMPLATE/feature_request.md | 11 ----------- .github/ISSUE_TEMPLATE/user_story.md | 4 ---- .github/PULL_REQUEST_TEMPLATE.md | 3 --- 4 files changed, 24 deletions(-) (limited to '.github/PULL_REQUEST_TEMPLATE.md') diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 48bad39b..af60c290 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -8,27 +8,21 @@ assignees: '' --- **Describe the bug** - **To Reproduce** - **Expected behavior** - **Screenshots** - **Environment setup (please complete the following information):** - **Additional context** - diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index eb6c3e4b..813974c1 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -8,34 +8,23 @@ assignees: '' --- ## Is your feature request related to a problem? Please describe. - - ## Describe the solution you'd like - ## Describe alternatives you've considered - ## User Stories (optional) - - - - - ## Additional context - diff --git a/.github/ISSUE_TEMPLATE/user_story.md b/.github/ISSUE_TEMPLATE/user_story.md index 52ae775d..d46976ba 100644 --- a/.github/ISSUE_TEMPLATE/user_story.md +++ b/.github/ISSUE_TEMPLATE/user_story.md @@ -6,11 +6,7 @@ labels: '' assignees: '' --- - - - - diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index f3371183..926b0548 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -6,15 +6,12 @@ assurance checks that should be done. What are the expectations --> #### Any background context you want to provide? - #### What are the relevant pivotal tracker stories? - #### Screenshots (if appropriate) #### Questions - -- cgit v1.2.3