Giter Club home page Giter Club logo

more-code-reviews's Introduction

Code Reviews

Goals

The goal of this activity it to practice the code review process using Github pull requests.

Instructions

In teams of 2-3:

  1. Select one student who will fork and add teammates as collaborators.
  2. Individually, clone the repository and select one (1) function from the list of functions to add.
  3. Individually, create a branch, write your function and tests (the code is provided), commit your changes, and push the branch up to the remote repository.
    • For example: If Jaeda is working on the merge_sorted_lists function
      1. They could create a branch named jaeda/merge_sorted_lists
      2. Then write their code and tests
      3. Verify the code works by creating a virtual environment, installing the dependencies, and running the tests with pytest
      4. Then use git add and git commit to commit their changes
      5. Then use git push origin jaeda/merge_sorted_lists to push the branch up to Github
  4. Open a pull request and add your teammates as reviewers.
  5. As a team, review each pull request using Github, writing comments and suggestions.
    • Specifically, look for:
      • Style and readability issues
      • Efficiency issues
      • Testing Issues
    • In addition, look for items to praise and learn from

To Review a Pull Request

In the Github repository, click on Pull requests and click on the pull request you want to review. Then select Files changed.

Select PR To Review

Fig. Selecting a PR to Review

Review PR

Fig. Selecting Files Changed


Then we can click on the + sign to add comments to lines of code.

Plus button

Fig. Using the + sign to comment on a line


Add a comment

Fig. Writing a comment

Finally, we will wrap up our review leaving a more general comment and Comment, Approve or Request Changes to submit.

more-code-reviews's People

Contributors

cheezitman avatar beccaelenzil avatar marlopez24 avatar kianashui avatar mitramagh avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.