From c41540931e2686d5efe60843dd36b21d929f5054 Mon Sep 17 00:00:00 2001 From: JT Olio Date: Wed, 20 Mar 2019 14:48:10 -0600 Subject: [PATCH] code review checklist (#1536) * code review checklist Change-Id: Id8e6c2d7e42d5b9b79e6f646e07f9c7c1f077405 * updates Change-Id: I1db2e3c09dc6d5cda89071e5f66783cc276352c0 * update Change-Id: Icf6d44795d024e67c630464db6cb2eb774f4f53e --- .github/pull_request_template.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..b0c09ebec --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,17 @@ + + + +## Code Review Checklist + - [ ] Does the PR describe what changes are being made? + - [ ] Does the PR describe why the changes are being made? + - [ ] Does the code follow [our style guide](https://github.com/storj/docs/blob/master/code/Style.md)? + - [ ] Does the code follow [our testing guide](https://github.com/storj/docs/blob/master/code/Testing.md)? + - [ ] Could the PR be broken into smaller PRs? + - [ ] Does the new code have enough tests? (*every* PR should have tests or justification otherwise. Bug-fix PRs especially) + - [ ] Does the new code have enough documentation that answers "how do I use it?" and "what does it do?"? (both source documentation and [higher level](https://github.com/storj/docs), diagrams?) + - [ ] Does any documentation need updating? + + +Thanks for submitting a PR! + +![](https://media.giphy.com/media/14nakW0jC4HA6k/giphy.gif)