Peer Code Review Instructions
In the Peer Code Review process, you will be reviewing your teammates’ pull requests. Your goal is to provide helpful, specific feedback that improves the correctness, design, readability, and maintainability of their code. Note: Your grades for the peer code review are based on an accurate review, not the ratings you give/receive for correctness, code style, and design.
To successfully complete a peer code review, you should:
- Understand what changed:
- Open the Pull Request and skim the title/description.
- Review the Files Changed tab to identify the main additions/edits.
- If commits are organized, skim commit messages to understand intent.
- Review supporting materials (if provided):
- Read any accompanying documentation (e.g., description, screenshots).
- Use these materials to understand the author’s design decisions.
- Leave in-line comments on the code:
- In the Files Changed tab, leave both:
- Positive notes (what’s well-structured, clever, clean)
- Constructive feedback (bugs, edge cases, unclear logic, overcomplicated solutions, style issues, etc.)
- Comments should be specific and actionable (point to the exact line, explain why, and suggest an improvement).
- Comments can also be clarifying questions.
- In the Files Changed tab, leave both:
- Complete the Peer Code Review Template:
- Copy-paste the template into the Conversation tab in the Pull Request view.
- Fill out all sections and submit the comment as your review.