Yep-Was-Taken / pupBuddy

0 stars 3 forks source link

Elbecr code review2 #36

Closed Elbech01 closed 2 years ago

Elbech01 commented 2 years ago

Code Review 2 - Christopher Elbe Analysis of the program: pupBuddy allows users to track their pets and the chores that correlate to them. It allows users to set up a profile of their household, including their pets and the people living in it. The program can keep track of who does what chore and when they did it, along with scheduling chores for people in the household to do.

Was the program available in UC GitHub on time? Yes, the program was available on time.

Is the program easy for you, as an outsider, to understand? Using the storyboard can help me understand the program, but there aren't many comments in the code to describe what is happening.

Does the program compile Yes, the program compiles.

Three commits I made:

  1. Added a width to an input for ease of use.
  2. Removed duplicate styling for buttons in the HTML code and replaced it with a button style in CSS.
  3. Removed a closing tag that had no correlating opening tag in household.html.

Specific technical concepts I learned

  1. The first technical concept I learned was being able to keep code clean. While doing the code review, I saw unused imports and it made me think of how having unused imports would happen to stay in a project. Going back and making sure code is clean is important. As stated in Java Clean Code, "Any fool can write code that a computer can understand. Good programmers write code that humans can understand." Clean code helps with being able to come back to some code later and remember exactly what that code is doing.
  2. The second technical concept I learned was to remove technical debt from someone's code. I feel my last code review wasn't that great at removing technical debt, but I think this time I was able to put the group's code in the right direction by removing duplicate code and unused code. In Technical Debt, the article states that, "The argument is that it takes time and effort to stop cruft from building up.", which is true, like with how I managed to see an unused HTML closing tag that was in the middle of a group of other HTML code. This might have never been seen without proper time and effort taken to reduce technical debt.
  3. The third technical concept I learned was the importance of commenting your code with Javadoc. After reading the documentation for JavaDoc, I realized it is so much more in-depth than simple comments are. Being able to comment on your code in specific ways like describing certain parameters. This would only help others understand your code if it becomes complex.

Links to three commits you made to your group's repository during Sprint 2. https://github.com/reediculous456/InventoryManager/commit/ced65016e9609748d9304c1498666d6c912d3cb4 https://github.com/reediculous456/InventoryManager/commit/b3736ba076d019dd20c71c6acf9c8e92dc875aea https://github.com/reediculous456/InventoryManager/commit/7336af2bfedafc9788c1b3cec04761a2869683d5

discospiff commented 2 years ago

In lieu of inline styles, I recommend linked styles. So, I would not recommend merging this branch in its current state.