yocarrotyo / HammockHelper

Hammock Helper is a java-based webapp for looking up hammock-friendly campsites at state parks in Wisconsin. Registered users can also add data about sites they're familiar with and help with validation of other users' submissions. Never pack a tent again!
http://3.12.23.13:8080/HammockHelper/
0 stars 0 forks source link

Review by Julie Johnson #3

Open jvjohnson1 opened 4 years ago

jvjohnson1 commented 4 years ago

Design/Code Review 1

Project: Hammock Helper

Developer: Caroline Hughes

Reviewer:

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
You’ve limited scope to Wisconsin, which is smart at the MVP stage. That means the basic rules are likely to be consistent between parks. If you expand to other areas, you may need rule pages or perhaps links to local DNR information
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
Kudos – simple, clear, and easy to use. No need to change except for new features if/when you go beyond MVP.
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
My advice is not to doubt yourself here! The structure of the database reflects the real world. There is a one-to-many relationship between parks and sites. There is no durable relation between a user and a site because camping is temporary by nature. There could be another one-to-many between user and review if you want.
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.
No issues found. Too early in the project for some of these standards to apply.
pawaitemadisoncollege commented 4 years ago

@jvjohnson1 Nice job with your review comments here. Please remember to also comment on code. You can view code directly in Github if you weren't able to review it together last night.

Examples:

When doing the code review portion, did you find any printStackTrace statements or printlns? If so, please indicate where so @yocarrotyo can easily fix them. If not, indicate none were found. Hint: the search feature is in Github can be useful for finding these.

Was the .gitignore there?

Classes sizes ok?