storj/.github/pull_request_template.md
2020-12-28 22:59:06 +01:00

24 lines
1.1 KiB
Markdown

What:
Why:
Please describe the tests:
- Test 1:
- Test 2:
Please describe the performance impact:
## Code Review Checklist (to be filled out by reviewer)
- [ ] NEW: Are there any Satellite database migrations? Are they forwards _and_ backwards compatible?
- [ ] 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/main/code/Style.md)?
- [ ] Does the code follow [our testing guide](https://github.com/storj/docs/blob/main/code/Testing.md)?
- [ ] Is the PR appropriately sized? (If it could be broken into smaller PRs it should be)
- [ ] 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?
- [ ] Do the database access patterns make sense?