Skip to content

Instantly share code, notes, and snippets.

@Alex-Tideman
Last active March 29, 2017 15:57
Show Gist options
  • Save Alex-Tideman/975c3911cc21f78ba11331e84c17bee5 to your computer and use it in GitHub Desktop.
Save Alex-Tideman/975c3911cc21f78ba11331e84c17bee5 to your computer and use it in GitHub Desktop.
Electron Project Peer Review

The Focus

The goal for the next hour is to practice your technical code review skills and providing critical feedback. On the job, code reviews are huge part of being on a team and being able to accept and implement feedback is a vital skill.

Feedback should be positive, actionable and clear enough that anyone reading the issue could implement without any clarifications.

Areas of Review

  1. Code Patterns - Identify coding patterns or practices that are detrimental to the code base or go against the majority of the code base (consistency). Are there too many global variables? Are you using .forEach instead of .map to create new arrays? Lots of if/else statements? Functions are too big?
  2. Style - Is your code consistently styled (spacing, naming conventions, file names)? Are you using a linter? Are you switching between ES5 and ES6?
  3. Communication - Are you writting concise commit messages? Are you using branches for small, complete pieces of functionality and have PR's with comments? Are you having conversations with teammates in the PRs?

What to do in a round:

  • Each round lasts 10 minutes
  • Each member of the team should pick one of three areas of review
  • Take one minute to demo your project or explain it to your 'opponent'
  • Go to your 'opponents' project repo and start reviewing their code
  • Open an issue for that repo with your feedback in the comment section of the issue. Name the comment in the following format:
    • Round [x] - [Area of Review]
    • Round 3 - Code Patterns
  • If your team in on a bye, you get 10 minutes with instructors to focus on ONE specific bug or feature you are struggling on

Final 10 Minutes

As a team, go through all of the issues (should be 12 total) and pick one issue for each of the three areas of review that you will implement in your project. Label that issue with the enhancement label.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment