jvjohnson1 / TheFortress

A secure coding demonstration that is intended to be attacked.
0 stars 0 forks source link

Peer Review 1 #5

Open NotSoFearfulSymmetry opened 3 years ago

NotSoFearfulSymmetry commented 3 years ago

Design/Code Review 1

Project: The Fortress (jvjohnson1/TheFortress)

Developer: Julie Johnson

Reviewer: Simon Powers-Schaub

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
Clear, concise, easy to follow.
Should be "comments stripped," not "comments striped."
Are military roles appropriate for users who are trying to break in?
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
Black text hard to read on fortress background.
Can people work solo on this, or do they need at least 2 or 3 people?
Ambiguity about the user's intended role and objectives.
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
Very detailed.
An illustration of some sort would make the layout easier to grasp.
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.
Did not show specific code.
pawaitemadisoncollege commented 3 years ago

@NotSoFearfulSymmetry Regarding Code feedback - you can view code directly in Github if you didn't have time to review it together last night. When doing the code review portion, did you find any printStackTrace statements or printlns? If so, please indicate where so @jvjohnson1 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?

NotSoFearfulSymmetry commented 3 years ago

Two printStacktrace statements in Database.java. The .gitignore is present, and the classes look to be good sizes.