Pull Request checklist

Pull Request checklist.txt

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