Git Product home page Git Product logo

code-review's Introduction

Peer Code Review

Congrats on completing your project! You wrote a lot of code over a period of a few days, and you've developed a working product from the ground up.

While we will build a lot of code throughout WDI, it's also important that we know how to read code. Code is usually only written once, but modified hundreds, if not thousands of times in software products. Your deliverable will be to read the code your peers wrote, summarize the code in your own words, and give feedback.

Getting Started

  1. Receive your partner pairing from your managers.
  2. For each developer in your group, spend some time understanding each project and how each project is structured.
  3. Spend some time looking through the code and figuring out how the code implements functionality in the project.
  4. Give each peer a writeup that consists of the following. You can give answers in an essay format, or by using bullet points. Either way, use Markdown if possible.
  • A short summary of the project's purpose.
  • A summary of project's organization, in terms of directories and files
  • For each major feature of the project, explain how the feature is implemented in terms of processes and architecture
  • At least 2 attributes of the project that you found successful or useful
  • At least 2 attributes of the project that could use improvement
  1. Submit each writeup via pull request. A template is provided for you to get started. You'll also want to reference your partner in the PR, so they can see the notes.

Note: For each attribute of the project, think in terms of user experience, styling, layout, and code readability. If you don't know what a section of code does, that may warrant a conversation about what could be improved. Remember KISS and DRY principles as well.


Licensing

  1. All content is licensed under a CC-BY-NC-SA 4.0 license.
  2. All software code is licensed under GNU GPLv3. For commercial use or alternative licensing, please contact [email protected].

code-review's People

Contributors

bhague1281 avatar mullfuchs avatar

Watchers

 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.