issues
search
yangdavid1985
/
Mtg-Collection
0
stars
1
forks
source link
Design/Code Review 1
#2
Open
LucasTolly
opened
7 years ago
LucasTolly
commented
7 years ago
Design/Code Review 1
Project: MTG Collection
Developer: David Yang
Reviewer: Lucas Tolly
Category
Criteria
Rating/Comments
Problem Statement
Does it exist?
reviewer rating/comments go here
Does the problem statement accurately describe project purpose?
Yes
Is the problem statement professional? Think of prospective employers viewing this as part of the developer's portfolio.
Yes
What is good?
The problem statement has a clear goal
What could be improved?
More specifics on how it will work would be good
Design Documentation
Does it exist?
Yes
Is the navigation/flow through the application logical and easy to use?
OK
Is the order in which the fields are displayed and form fields entered logical and easy to use?
Could be improved
What data is missing?
none
Is there data that is not used?
no
What is good?
What could be improved?
Could use a little more white space so its less cluttered
Data model
Does it exist?
Yes
Is everything on the screens represented in the model?
Sort of
Does the model represent good database design?
User Collection should be a linking table between users and magic_cards
What is good?
necessary tables are there
What could be better?
could use more fields for the cards and users
Additional design documents
Application structure in IntelliJ
Does it exist?
Yes
Is the structure correct for a Maven project?
Yes
Are packages and classs appropriately named?
Yes
Other comments/notes?
JSPs
Do they exist?
Not yet
Is templating used (for example, header.jsp, footer.jsp, etc.)?
Is there business logic mixed in the JSPs?
CSS?
Other comments/notes?
Entities/DAOs/Controllers
Do they exist?
Not yet
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?
Not yet
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?
Not yet
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?
yes
What web services/apis might work well with this application?
Independent research topic
Has a topic been selected?
not yet
What topic/s might fit well in this application?
pawaitemadisoncollege
commented
7 years ago
[ ] Is everything on the screens represented in the model? ==>Sort of <==What is missing?
[ ] what are your suggestions for an independent research topic?
Design/Code Review 1
Project: MTG Collection
Developer: David Yang
Reviewer: Lucas Tolly