Code Review Checklist

code-review-checklist.md

Pair-to-Pair Code Review

15 mins

• Get together with your group and send a link of your team's GitHub Repo to the pair that is reviewing your project.
• Look over this guide with your project partner and highlight the pieces where your team can use assistance/you would like your reviewers to take a closer look

60 mins

• Follow the instructions to clone down the repo you are given and start reviewing the codebase. Take notes for written feedback.

15 mins

• Come back together in your larger group. This time should be used to have an in-person discussion about the feedback. Send your formal written feedback as a gist/document to the pair and your instructors.

Review Guide

While reviewing the code, ask yourself the following questions:

CODEBASE

• Does the code work? Does it perform its intended function, the logic is correct etc.
• Is all the code easily understood?
• Does it conform to Turing's Style Guide? These will usually cover location of braces, variable and function names, line length, indentations, formatting, and comments.
• Is there any redundant or duplicate code?
• Does the code follow the principle of single responsibility?
• Can any global variables be replaced?
• Is there any commented out code? Any console.logs?
• Do the names used in the application convey intent?
• Do tests exist, and are they comprehensive?
• Do unit tests actually test that the code is performing the intended functionality?
• Does the repo have a .gitignore file? Is there a .DS_Store file or node_modules directory committed that shouldn’t be?

README

• Does the README follow the conventions we discussed in class (i.e. Abstract listed first, install instructions second, everything else listed after)
• Is there a link to the DTR for the team available?
• Is there a wireframe for the project available?
• Is there anything that is confusing or hard to understand with what is written?
• Does the README do a goob of showcasing this project? If you were a random human who happened to come across this project, would you explore it further based on the current state of the README?
• What suggestions would you make for making the README better?

GITHUB/ISSUES/WORKFLOW

• Are issues being used to keep track of tasks, enhancements and bugs?
• Do the titles/descriptions of the issues provide all the relevant/necessary details for the issue? Would you be able to jump right in and assist?
• Are other strategies being used to keep track of issues (labels, milestones, assignments)?
• Is there effective communication happening in PRs outside of working school hours?
• Do the PRS follow the flow that we discussed in class?
  • Summarize the changes that you made.
  • Give the reason WHY you made those changes
  • Ask for any insights

Feedback

You will be writing a formal piece of feedback (with your partner) to give to the team whose project you reviewed this morning. Use these questions as a guide; however, you are also free to give additional project feedback on anything that may have been overlooked with the questions listed above. Feedback is due by the end of the session. Please save your feedback as a file or gist and send it to your instructors and the pair. Remember to follow the feedback guidelines you went over as part of your professional development in Mod 1.

Class structure looks good so far and methods seem to make sense for what you are looking to do with them and starting to come together in terms of the logic within them, just need to start working on the interactions between those. Workflow looks good so far, could maybe give a little more detail in PRS. From the bit of talking we did though seems like it's working well for you guys. I would say when you start working on gameplay flow to get all of the HTML together in one file and work on that styling and flow since that will take a bit of logic as well. Should just take some playing with divs, opacity, and z-index though on the styling side so not too bad. Seems like you guys are off to a great start though!

I like the way you set up your game board with the 4 arrays. instead of having a different html file for the player name inputs maybe add a card that appears over the homepage, it could go away and initiate the game when you press enter. overall I think your code looks good and is easy to understand. to answer your question about what methods I can see that you should add maybe add an endRound() and a startRound() method in game.js or round.js, keep up the good work.