Skip to content

Project 1 Code Review

Practice!

I recommend walking through the following on your own prior to turning in your project. Do this as many times as you need to become comfortable walking through your code and staying within the time-limit. Often by going through this process you find corrections or things that can be improved upon.

Code Review Process

Take Notes!

You are expected to take notes during the code review to capture any feedback the instructor may give. A document has been provided for you: screenshots/project1/code-review-notes.

Part 1: Code Walkthrough

Step through the code explaining the flow and logic of the program. Keep this around 10 minutes. Remember to use the correct Java terminology. Avoid using words like "this over here" or other vague phrasing. Be specific in your description of the flow and logic.

Part 2: Code Questions

Be prepared to answer the following questions about your project code.

  1. Provide one example of how you debugged a problem in your Java code.

    1. Was it a compiler, runtime, or syntax error?
    2. What did you identify the source of your error?
    3. How did you solve the error?

  2. What Java Best Practices are used in your code?

  3. Identify an area of the project where a Programming Principle is used. How does it improve the code quality?

  4. Identify an OOP concept in the project and its purpose. How does it improve the code quality?

  5. What concrete implementations of the Collection interface did you use in this project? Why?

Code Review Tips

  • Reading this short article will help you understand some of specific issues we will focus on in the review.
  • Ask for clarification and/or help before your scheduled code review if you are stuck on any aspect of the project.

Feedback

You are responsible for taking notes during the code review. Jot down any improvements, recommendations, and comments the instructor provides during the code review. There is a document in your projects directory under each project folder for taking notes: code-review-notes.md.

Additional feedback on the rubric items below, as well as the "Met" or "Not Met" mark, will be added to your project issue for you to review.

Rubric

All of the following must be satisfied to achieve a "Met" status

  • The flow and logic of the Java program is explained using correct Java terminology.
  • The explanation is clear, and concise.
  • At least one debugging example is shared including, the error type, source, and solution.
  • A Java Best Practice, Java Principle, and an OOP concept are identified and explained.
  • Identification and rational for using Java Collection classes.

Making Corrections

  1. If your code review is at a "Not Yet" status, you can redo your code review in the form of a video.
  2. Keep the video under 20 minutes and send me the completed recording in Slack once complete.