Skip to content

Latest commit

 

History

History
67 lines (35 loc) · 2.13 KB

SPECS_forReviewers.md

File metadata and controls

67 lines (35 loc) · 2.13 KB

##S.P.E.C.S.

###Simplify Code: How can this code be simplified somehow?

Examples:

###Practice Kindness: It is always important to remember that the review is being provided to a student who has invested several hours of their lives into the project we are reviewing. Resources:

Stack Overflow Model

In short: Be Nice:

  • Rudeness and belittling language are not okay.
  • Be welcoming, be patient, and assume good intentions.
  • Don't be a jerk.

Example: Highlighting Awesome Code Snippets

###Explain Why and with Examples: Explain why using online references and creating code snippets with Github's Gist Tool. Gist is a simple way to share snippets and pastes with others.

Resources (mostly on semicolons):

###Connect Learners: A good Code Reviewer connects the student to a source of knowledge they did not previously have.

Examples:

  1. Tech Talks
  2. Code libraries like PyPi & Cocoa Pods
  3. Twitter and Meetup groups

###Style Consistently It does not matter what style guide the student uses as long as they're consistent with the styles they use throughout their code.

Resources:

Helpful sample reviews: