maitlandk90 / VeteranHuntersHelping

Independent for Enterprise Java
0 stars 0 forks source link

Veterans Hunters Helping Code Review - Dan Miller #3

Open drmiller1 opened 6 years ago

drmiller1 commented 6 years ago

Design/Code Review 1

Project: MHW Veterans Hunters Helping

Developer: Kyle Maitland

Reviewer: Dan Miller

Item Considerations Comments/Suggestions
Reviewer comments and suggestions go here. Each item should have at least one "kudos" and two suggestions for improvement
Problem Statement 1. Accurately describes project purpose
2. Is professional and free of typos, slang, etc.
3. Fully explains the problem and the solution
4. Is understandable by the average person
Nice job writing the problem statement in a way that even a person who doesn't play the game can understand what your project is trying to accomplish.

More detail could be added to help the reader understand more about the game itself, including more examples of how a veteran can help a novice.

Reread the problem statement looking for gramatical errors.
Design Documentation 1. Navigation/flow through the application is logical and easy to use.
2. The order in which values are displayed are logical and easy to understand/use
3. The order in which the form fields entered are logical and easy to understand/use
4. All data discussed/documented (problem statement, flow, db design, etc.) is represented on the screens
Nice job on the design screens. I like the use of the twitter feed for communication between users.

The screens look like they have a good flow and are understandable for a veteran, but I'm wondering if more detail could be added for the novice.

Data model/Database 1. Everything on the screens and problem statement/flow is represented in the model
2. There is at least one 1-to-many relationship.
3. The model represents good database design
The database design model is steup well and I like the use of the create/drop/insert sql.

The one to many relationships on the data model could be more clear.

Are all of the tables with id/name needed or could they be combined into one table?
Code 1. Proper Maven project structure is used
2. a .gitignore file for IntelliJ Java projects has been implemented
3. There is not any redundant or copy/paste code in the JSPs or classes
4. Classes are appropriately-sized (no monster classes)
Property files are used appropriately: no hard-coded values
5. Logging statements are used rather than System.out.println and printStackTrace.
6. There are appropriate unit tests/code coverages.
Good start on the .jsp's. Also, the hibernate classes are well organized.

A log folder could be created to hold all of the logging statements.

At some point the junit tests will need to be created for all of the unit tests and code coverages.