Week 12: Code review
In this session, we ask you to review the code of another group, i.e., their pull request. You will adopt the perspective of a maintainer, i.e., a gatekeeper who takes responsibility for an open-source project by screening, improving, and integrating code contributions.
The objective is to develop the ability to collaboratively review code contributions by downloading, testing, and debugging code, while providing constructive and respectful feedback in GitHub pull requests.
As a group, your goals are to:
- Download the code from the pull request (fork) to your local machine or Codespace
- Test whether the code works as expected
- Debug and improve the code (if necessary)
- Document your assessment in the pull request on GitHub and suggest merging, revising, or rejecting the contribution
Keep in mind that your review should be constructive and respectful, encouraging the contributors to revise their work and continue to be part of the community.
| Materials | Link |
|---|---|
| Slides |   |
Resources: GitHub Best Practices for Maintainers
Project completion in week 13
After receiving the review, please incorporate the feedback to ensure your contribution is merged and the project is completed. During this stage, we will oversee the process to help you finish the project by week 13. This may involve determining which revisions are essential and which can be skipped.
Implement the feedback provided in the pull request (deadline).
Upon completion, we celebrate the accomplishments of our students in the hall of fame and the official list of contributors 🎉 🍾 🎈