JoeDowling2020
commented
3 years ago | 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 | Readme file and problem statement seem to be missing. Overall plan for the project is well thought out and supported by user stories, wireframes and a flow chart of the application. | |
| 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/use4. All data discussed/documented (problem statement, flow, db design, etc.) is represented on the screens | As mentioned the design documentation is very good. Use of markdown or HTML would greatly increase the presentation of the information. The flow chart only tackles some of the user stories so adding more would show the complete vision for the application! | |
| 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 | No data model or database design document to comment on. | |
| 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. | Very similar to myself, the project structure is complete but is missing logging implementation (although unlike mine there were no system.out.printlns!) and some java docs. Everything else looks good with tests written for all current DAOs. |