W04 Code Review: Review of Week 03 Pull Requests
Overview
- Purpose: Practice reviewing pull requests and providing useful feedback.
- Task: Follow the review instructions below and share your feedback with your team.
Begin this week by reviewing your teammates' Week 03 pull requests. Each person on the team should review at least one pull request from another person. You may need to review more than one, depending on the number of pull requests your team has created..
For more information on the code review process, you can refer back to the Week 03 Learning Activity: Code Reviews. Each person must complete at least two GitHub reviews, and the team must make sure every PR receives a review and is merged after approval.
Required Review Content
For the code review assignments in this course, each code review you submit must include at least two meaningful statements. At least one statement should address behavior, testing, security, data modeling, or documentation.
A review that only says "looks good" is not enough. If the pull request is truly simple and correct, explain what you checked before approving it.
Review Instructions
- Open the pull requests from your team that are ready for review.
- Read the linked issue and the pull request description.
- Watch the video from your teammate that demonstrates the feature and explains the code.
- Review the changed files carefully.
- Add a GitHub review with meaningful feedback or an approval summary. Leave specific comments about bugs, missing requirements, confusing code, or good implementation choices.
- Approve the pull request only when it is ready to merge.
- If all open PRs have already been reviewed, you may review a closed PR for additional practice and submission evidence.
- Help your team make sure approved PRs are merged.
Review Checklist
Use this checklist while reviewing teammate PRs:
- The PR links to or mentions the GitHub issue.
- The PR description explains what changed.
- The PR description includes testing notes.
- The changed code matches the issue scope.
- The change follows existing project patterns.
- Mongoose models or queries are correct for the feature.
- Errors return safe JSON responses.
- Swagger documentation is updated if API behavior changed.
- No secrets or sensitive data were committed.
Submission
Return to Canvas and submit links to at least one GitHub review you completed this week.
Other Links:
- Return to: Week Overview | Course Home