jbrischke / RatingsAnonymous

0 stars 0 forks source link

Design/Code Review 1 - Ryan Michaelis #7

Open MichaeliRM30 opened 2 years ago

MichaeliRM30 commented 2 years ago

Design/Code Review 1

Project: Ratings Anonymous

Developer: Josh Brischke @jbrischke

Reviewer: Ryan Michaelis

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
1. Project purpose clearly defined.
2. I'm no English major, but there might be a run-on sentence.
3. I feel like the solution could have more detail. (Functionality, differentiation)
4. Easy to understand.
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
1. Application Flow makes sense! Database is straight forward. Do you need more than one? User Stories are good!
2. So far everything makes sense. Need more time to build out maybe.
3. Looks like more time might be required.
4. I think the wire frames are still being built out, but I'm sure you've got this!
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
1. I'm not certain I can find a model, but the SQL to build the database and tables looks solid. Like the tables and columns.
2. I'm assuming userId being your primary key is a very smart strategy and translates nicely to your tables.
3. Model may be in progress.
Code 1. Proper Maven project structure is used
2. .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 coverage.
1. Modeled after the example and modified - smart.
2. .gitignore is there and looks good!
3. Good start on JSP's.
4. CLike my own project, some code needs to be built out yet.
Like my own project, some code needs to be built out yet.
5. I know the logging statements are coming!
6. Along with Test code. You'll get it done.