Before opening a pull request, stop being the implementer and become the reviewer. Take a real break, then inspect the change with fresh eyes. This catches obvious defects, missing context, unanswered questions, and unnecessary files before they create reviewer back-and-forth. section 2.4.2
Run a self-review by asking:
- Did linters, formatters, static analyzers, and unit tests run, and were their obvious findings fixed? section 2.4.2
- Does the change satisfy its acceptance criteria and include only relevant files? section 2.4.2
- Can a reviewer understand the change from the code and pull-request information alone? section 2.4.2
- Have edge cases, architectural fit, and likely reviewer questions been considered and documented? section 2.4.2
Before marking a pull request ready
Write down questions a reviewer might ask and answer them in the pull request. Revisit the change more than once, revising until the code and its context stand on their own. section 2.4.2
