jlemke / pathfinderProject

A website where I can save my Pathfinder character sheets and GM notes.
0 stars 0 forks source link

Peer Code Review-1 nkf #5

Open javaneil opened 7 years ago

javaneil commented 7 years ago

Design/Code Review 1

Project:

Pathfinder

Developer:

Joe Lemke

Reviewer:

Neil Fortney

Category Criteria Rating/Comments
Problem Statement Does it exist? yes
Does the problem statement accurately describe project purpose? Provides good detail and examples of similar applications
Is the problem statement professional? Think of prospective employers viewing this as part of the developer's portfolio. yes
What is good? Well organized with priortized list of goals
What could be improved? Could use a little more overview of the application for those not familiar with roll-playing games
Design Documentation Does it exist? yes
Is the navigation/flow through the application logical and easy to use?
Is the order in which the fields are displayed and form fields entered logical and easy to use? There is a large number of tables to navigate making it somewhat difficult to express easily
What data is missing? did not appear so
Is there data that is not used?
What is good?
What could be improved?
Data model Does it exist? in IntelliJ
Is everything on the screens represented in the model?
Does the model represent good database design?
What is good?
What could be better?
Additional design documents
Application structure in IntelliJ Does it exist? yes
Is the structure correct for a Maven project?
Are packages and classs appropriately named?
Other comments/notes?
JSPs Do they exist? yes
Is templating used (for example, header.jsp, footer.jsp, etc.)?
Is there business logic mixed in the JSPs?
CSS? yes
Other comments/notes?
Entities/DAOs/Controllers Do they exist? yes
Java code quality Are methods single-purpose?
Are classes appropriately-sized classes (no monster classes)?
Are the same lines of code repeated at all?
Do any classes perform very similar functions that could be candidates for super/subclass relationships?
Are any values hard-coded that should be in a properties file?
Are variable names descriptive?
Are there many branches or loops that could be simplified or broken up into smaller methods?
Do the DAOs use Hibernate? No hard-coded sql!
Other comments/notes?
Logging Has log4J been added? yes
Are there logging statements in the code?
Are appropriate logging levels used? Info, debug, error, for example.
Are there any System.out.printlns in the code?
Other comments/notes?
Unit Tests Do they exist? yes
Do the tests pass?
What is the current code coverage?
Is each test truly a unit test or are they functional tests?
Other comments/notes?
Web Service/API integration Has a web service/api been selected? todo
What web services/apis might work well with this application?
Independent research topic Has a topic been selected? AngularJS
What topic/s might fit well in this application?
pawaitemadisoncollege commented 7 years ago

I'm not sure if you are finished with the review, but please be sure to fill out the details for the main sections. For example, are there logging statements, are there any system.out.printlns?

javaneil commented 7 years ago

Hi Paula, sorry it's so incomplete, but I honestly do not think I'll be getting back to reviewing the code any further or making any updates...

-neil


From: Paula Waite notifications@github.com Sent: Saturday, February 11, 2017 12:56 PM To: jlemke/pathfinderProject Cc: Fortney, Neil K; Author Subject: Re: [jlemke/pathfinderProject] Peer Code Review-1 nkf (#5)

I'm not sure if you are finished with the review, but please be sure to fill out the details for the main sections. For example, are there logging statements, are there any system.out.printlns?

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHubhttps://github.com/jlemke/pathfinderProject/issues/5#issuecomment-279167558, or mute the threadhttps://github.com/notifications/unsubscribe-auth/AP9BF8vXCgqjcuNPn-HwjYpDVZ41SMTyks5rbgREgaJpZM4L9gGU.