Skip to content

Instantly share code, notes, and snippets.

@pbyrne
Created October 29, 2012 19:11
Show Gist options
  • Save pbyrne/3975818 to your computer and use it in GitHub Desktop.
Save pbyrne/3975818 to your computer and use it in GitHub Desktop.
Sample Interactive Pull Request

Introduction

I want to prompt for some specific questions and then insert them into a template.

In no particular order:

  • title
  • description
  • qa plan
  • special deploy instructions?
  • target process IDs?
  • helpspot tickets?
  • urls? (maybe roll into helpspot tickets)
  • Is this a Release pull request?
  • (if yes to above) Who to assign to (Cory, Steve, whomever)

Sample Release Pull Request

$ bundle exec pull-request
Preparing a pull request for ngin/my-awesome-branch to ngin/production.
Title: My Awesome Thing
Description (1 or 2 sentences): This adds the cool new "never broken" feature which fixes all bugs.
Target Process IDs (comma-separarated, blank if none): 123,456
Is this a Release pull request? (y/n)
> y
Assign to which project owner?
1. Bob Manager
2. Sally Manager
> 1
Creating pull request... Will open in the browser when ready.

Creates a pull request titled "Release: My Awesome Thing" and assigned to Bob Manager and opens it in their browser. It also mentions @bobmanager in a comment so that they have visibility into it.

This adds the cool new "never broken" feature which fixes all bugs.

Deploy Plan
-----------

Does Infrastructure need to know anything special about this deploy? If so, keep this section and fill it in. Otherwise, delete it.

Target Process
-------------
* [TP123](http://tstmedia.tpondemand.com/restui/tpview.aspx?#task/123)
* [TP456](http://tstmedia.tpondemand.com/restui/tpview.aspx?#task/456)


URLs
----

* replace with any helpspot or
* other URLs relevant to 
* the pull request

QA Plan
-------

1. Replace with steps to test the bug.
2. Rejoice as your colleagues rejoice at the ease of testing your bug.
3. Remember to be thorough.

Sample Non-Release Pull Request

$ bundle exec pull-request
Preparing a pull request for ngin/my-awesome-branch to ngin/production.
Title: My Awesome Thing
Description (1 or 2 sentences): This adds the cool new "never broken" feature which fixes all bugs.
Target Process IDs (comma-separarated, blank if none):
Is this a Release pull request? (y/n)
> n
Creating pull request... Will open in the browser when ready.

Creates a pull request titled "My Awesome Thing" and assigned to no one and opens it in their browser.

This adds the cool new "never broken" feature which fixes all bugs.


Deploy Plan
-----------

Does Infrastructure need to know anything special about this deploy? If so, keep this section and fill it in. Otherwise, delete it.

URLs
----

* replace with any helpspot or
* other URLs relevant to 
* the pull request

QA Plan
-------

1. Replace with steps to test the bug.
2. Rejoice as your colleagues rejoice at the ease of testing your bug.
3. Remember to be thorough.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment