Skip to content

Instantly share code, notes, and snippets.

@0atman
Created December 8, 2015 17:13
Show Gist options
  • Save 0atman/844d425f413e4181887d to your computer and use it in GitHub Desktop.
Save 0atman/844d425f413e4181887d to your computer and use it in GitHub Desktop.
A template CONTRIBUTING file, for hygienic PRs

PR Template

Copy and paste this into your PR description. Sections are fine to be blank, but own the fact they are blank and leave them in. No documentation can be ok, but it must be deliberate.

## Description
A few sentences describing the overall goals of the pull request's commits.

## Related
List related PRs, issues, trello cards, etc.

## Documentation
A description of what has been updated.

## Link to demo/screenshots
http://example.com/wouldnt/it/be/nice

## Steps to Test or Reproduce
Outline the steps to test or reproduce the PR here, eg:

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