Skip to content

Instantly share code, notes, and snippets.

@adamyanalunas
Created March 30, 2016 22:07
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save adamyanalunas/48b4d739574ee576e6c7394bb6daf273 to your computer and use it in GitHub Desktop.
Save adamyanalunas/48b4d739574ee576e6c7394bb6daf273 to your computer and use it in GitHub Desktop.

Addresses issue: #

Preflight (optional)

  • List work to be done before PR can be reviewed
  • Keep this as brief as possible, this is not a place for storytelling
  • bundle install or bundle exec pod install
  • Reading some backstory
  • Set up credentials someuser@domain.com/password in the “foo” database

Expectations

Be explicit about the scope of the PR. Describe what works.

Also describe what the PR is not meant to accomplish and what is known to be broken/missing/wrong.

Review

Describe instructions on how to test these changes from the viewpoint of someone who has no familiarity of what lead you here; they often may not. It is your burden—not the reviewer’s—to supply context for a reasonable review. Give the reviewer the right tools so they are more likely to understand and, hopefully, approve your changes.

These instructions could be written out or…

  1. You can also use ordered lists
  2. If steps have an explicit order

If you need to include code snippets use the block format with the correct language so the syntax is properly colored.

- (void)viewDidLoad
{
    [super viewDidLoad];

    // Code described here for reasons
}

Tests

CI will run tests for some projects but this is your chance to talk about why some tests are failing and why they haven't been addressed in this PR. It’s polite to include something like “All tests pass” so the reviewer is aware that you ran tests before opening the PR.

Postscript (Optional)

Space for any closing thoughts, other approaches considered but not implemented, etc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment