CST 338 Week 3

 

• Whos code did you review? Tim Shaker
• The reviews you wrote:
  Overall Tim's code is clean and easy to read. I didn't see any major and minor issues with his code. The way he wrote code is the conventional way to write code in java. His variables are type and named properly. All the test cases pass, the whole project runs properly and the logical flow is easy to follow along.
• Summarize the feedback you received about your code from your peers:
  Overall I received positive feedback from my peers. Had some java doc confusion with one of the methods I wrote since my documentation can be misleading if interpret in a different way. Also pointed out to not forget my TODOS in my code.
• Identify any trends you noticed when evaluating the code of others
  • such as: everyone struggled with sorting or unit tests that were hard to pass

  The trends I notice is that my peers pretty much write almost identical as mine (not in a bad way). I guess it is good everyone has the same way of solving some of the problems which makes it easier to follow the logic flow. It maybe because I'm already familiar on what needs to happen for each method but it was easy for me to read the code nonetheless. I did not see any hint of struggle with how they wrote the code.

Answers to the following

1. What improvements would you make to your code/what was suggested? 
   Double check my documentation. Make sure I convey what each method does to avoid confusion as much as possible. Delete my TODOS after I'm done.
2. Which unit tests were the hardest to pass?
   I don't specifically recall which one was the hardest. I believe each one of them is equally as hard or as easy as the other one. With following the requirements and re-reading what needs to happen for each methods slowly help me pass the test cases 1 by 1.
3. How do the existing tests function and could they be improved?
   1. Do the existing unit tests cover the full range of the sub classes?
      I believe so since once the whole project compile run and has all the expected result on how it is meant to play, the whole test cases runs properly as well
   2. How would you change the unit tests? Not change but maybe add more cases that can break the code. For example create a specific test for the makeGuess() method since that one is the main method the whole project use. Add some scenario where user input a different data type like a string, an int or double or anything a user can click on their keyboard etc.
      1. Keep in mind I do not want them to change but this doesn't mean I think they are perfect.  Reading through the tests is a good way to learn what the code should do thinking about how to test the codeis a good way to learn how to make tests.
4. What did you struggle with? Just going overall the whole documents and requirements of the project. The project itself sounds easy but when going through everything was the hardest. I'm not sure where to start and which method I should do first. Basically having a hard time to look where to start to have a proper workflow on how thing should be done. 
5. What did one of your teammates struggle with?
   Same as me, going over the whole project and how to go about and where to start.
6. Was any part of the code a struggle for YOU?
   Yes, makeGuess() and getHint() method
7. Was any part of writing the code easy for YOU?
   Anything that doesn't require a big amount of logic.
8. What was your biggest HW1 victory?
   This might sound too generic but making the whole thing run. Once I was able to run and debug it, it was easier for me to follow along and look the mistakes that I did when I was doing it without being able to run.