From 8c2d2f40d389c096197f1bc8d5434b2e42ed148c Mon Sep 17 00:00:00 2001 From: Stephen Dolenc Date: Thu, 6 Jul 2017 13:16:41 -0700 Subject: [PATCH] pr template updates (#94) pr template fixes --- .github/PULL_REQUEST_TEMPLATE.md | 24 ++++++++++-------------- 1 file changed, 10 insertions(+), 14 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 90ff2d9..dc1a061 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,5 +1,5 @@ -#### What's this PR do? Any additional context? +#### What does this PR do? Please provide some context #### Where should the reviewer start? @@ -10,27 +10,23 @@ #### Definition of done: - [ ] Title of the pull request is clear and informative - [ ] Add pull request hyperlink to relevant TFS items -- [x] For large or complex change: schedule an in-person review session - -[//]: # ( todo: Is there appropriate test coverage? ) -[//]: # ( todo: Does this PR require a new Selenium test? ) -[//]: # ( todo: Is there appropriate logging/monitoring included? ) +- [ ] For large or complex change: schedule an in-person review session +- [ ] This change has appropriate test coverage #### Reminders BEFORE merging 1. Get at least two approvals -1. If you're merging into the development branch then "flatten" or "squash" commits -1. If merging from development into master then don't "flatten" or "squash" commits +1. If you're merging from a feature branch into the development branch then "flatten" or "squash" commits +1. If merging from the development branch into master (or porting changes from upstream) then use github's UI to get review feedback, but use the git command line interface to complete the actual merge. #### Reminders AFTER merging -1. Delete the remote branch +1. Delete the remote feature branch 1. Resolve relevant TFS items -1. (reverse merge) If you merged into master then check to see if there are any changes in master that can be merged down to the development branch (like hotfixes, etc) +1. (reverse merge) If you merged from the development branch into master then check to see if there are any changes in master that can be merged down to the development branch (like hotfixes, etc). In this case, use github's UI for feedback and the git command line interface for the actual merge. [//]: # ( todo: If you merged into development branch then verify change in our "rolling deployment" environment. Then notify stakeholders interested in or involved with the change ) - [//]: # ( fyi: This content was heavily inspired by ) [//]: # ( 1 Our team's policies and processes ) -[//]: # ( 3 https://github.com/sprintly/sprint.ly-culture/blob/master/pr-template.md ) -[//]: # ( 4 The book "The Checklist Manifesto: How to Get Things Right" by Atul Gawande ) -[//]: # ( 5 https://github.com/Azure/azure-event-hubs/blob/master/.github/PULL_REQUEST_TEMPLATE.md ) +[//]: # ( 2 https://github.com/sprintly/sprint.ly-culture/blob/master/pr-template.md ) +[//]: # ( 3 The book "The Checklist Manifesto: How to Get Things Right" by Atul Gawande ) +[//]: # ( 4 https://github.com/Azure/azure-event-hubs/blob/master/.github/PULL_REQUEST_TEMPLATE.md )