Last active
April 9, 2018 10:13
-
-
Save amupoti/565dc5f90a03332b594212e7e1d0bac4 to your computer and use it in GitHub Desktop.
Pull Request checklist
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
SCOPE | |
story is high priority, small, minimize creep, no stray changes, off-task changes added to backlog | |
WORKS CORRECTLY | |
master merged into branch, | |
all changes tested, | |
edge cases covered, | |
cannot find any ways these changes break some other part of the system, | |
DEFENSIVENESS | |
all inputs to public methods validated | |
fails loudly if used incorrectly | |
all return codes checked | |
security | |
EASY TO READ AND UNDERSTAND | |
appropriate abstraction and problem decomposition | |
minimum interface exposed | |
information hiding | |
command-query principle | |
good naming | |
meaningful documentation and comments | |
fully refactored (use judgement with existing code) | |
STYLE AND LAYOUT | |
all inspections pass | |
code formatter run | |
no smelly code styling | |
line length | |
styling consistent with project guidelines | |
Taken and adapted from https://dev.to/bosepchuk/a-code-review-checklist-prevents-stupid-mistakes-o6 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment