Python · Intermediate level

Intermediate level · Module 6: Python Intermediate Project Studio · Lesson 2 of 3

Publishing on GitHub and Reviewing Code

Push work to GitHub, write a project README and give and receive code review.

In this lesson you will

  • Push a repository to GitHub
  • Review a peer's code using a checklist

Key concepts

remotepushREADMEcode review checklist

The lesson

GitHub hosts Git repositories online, so your code is backed up and can be shared with teammates, clients or employers as a portfolio. git push sends your commits to GitHub; git pull brings down others' changes.

Code review is a structured reading of someone else's code: Does it run? Is it clear? Are errors handled? Is any personal data or secret exposed? Good reviewers comment on the code, not the person, and suggest specific improvements.

Check what you publish. Removing a password from a later commit does not remove it from history; if a secret is pushed, change it immediately.

Step by step

  1. Create a repository on GitHub.
  2. Connect it with git remote add origin and push.
  3. Open a classmate's repository and run their project.
  4. Complete the review form with three specific comments.

Practice activity

Publish your project to GitHub and complete a structured review of a classmate's repository.

Expected result: A public or private GitHub repository and a completed review form for a peer.

Check your understanding

  1. Name two things a code review should check.

    Show answer

    Any two of: correctness, readability, error handling, security, tests, documentation.

Taught live by an instructor — online or in person. Free course lessons are for self-study and do not lead to a certificate — see registration options.