3.5The PR Review Process

As a PR Author

1. Self-review first: Read your own diff before requesting review. You will often catch issues yourself.
2. Add context comments: If a section of code is non-obvious, add a PR comment explaining it before the reviewer has to ask.
3. Mark draft PRs as draft: If the PR is not ready for review, use GitHub's draft PR feature so reviewers do not waste time.
4. Respond to feedback promptly: A PR that sits for days after review feedback stalls the team.
5. Do not take feedback personally: The reviewer is critiquing the code, not you.

As a PR Reviewer

1. Understand the context: Read the PR description and linked issues before looking at the code.
2. Review the tests: Are assertions meaningful? Is the test deterministic? Does it clean up after itself?
3. Check for edge cases: What happens with empty inputs, null values, network errors?
4. Look for hardcoded values: Are URLs, timeouts, and credentials configurable?
5. Verify naming: Can you understand what each test does from its name alone?