Summary and Schedule
This is a Byte-Sized RSE lesson on code review, part of the Byte-Sized RSE Series.
Learning Objectives
At the end of this lesson, learners should be able to:
- Identify benefits of coding with others, including improved code quality and shared ownership.
- Recognise common collaborative practices such as code review, pair programming, and version control.
- Understand how early adoption of collaborative tools helps prepare for scaling up development.
- Apply the practical collaborative strategy code review in a software project.
| Setup Instructions | Download files required for the lesson | |
| Duration: 00h 00m | 1. Introduction |
What are the benefits of collaborative code development? How can collaborating improve the quality and effectiveness of your code? What practices and tools support effective collaboration? Why should collaborative tools and workflows be adopted early in a project? |
| Duration: 00h 15m | 2. Example Code | What does a bad code repository look like? |
| Duration: 00h 25m | 3. Fixing a Repository Issue |
How do we approach grouping commits together for a pull request? Can we use GitHub to directly make changes to files? |
| Duration: 00h 35m | 4. Submitting a Pull Request |
How do you create a pull request using GitHub? How long should we keep a pull request open? How do we request a review of a pull request? |
| Duration: 00h 45m | 5. Reviewing a Pull Request |
How do I submit a review of a pull request? On what information about a pull request do I base my review? What are the levels of approval for a pull request review? |
| Duration: 00h 55m | 6. Merging a Pull Request |
How do I see the comments left by a reviewer? How do I merge a pull request? |
| Duration: 01h 05m | Finish |
The actual schedule may vary slightly depending on the topics and exercises chosen by the instructor.
Setup
- Account on GitHub.com
- Understanding of Python syntax to be able to read and follow code examples
GitHub Account
GitHub is a free, online host for Git repositories that you will use during the course to store your code in so you will need to open a free GitHub account unless you do not already have one.