Skip to content

REVIEW.md

Latest commit

 

History

History
43 lines (27 loc) · 1.41 KB

REVIEW.md

File metadata and controls

43 lines (27 loc) · 1.41 KB
Raw

Reviewer Instructions

Thank you for taking the time to review this project.
Please follow the steps below to provide structured and valuable feedback:

What to Review

Start with the README.md file located at the root of the repository. It contains the project overview, setup instructions, and key technical decisions.

As you review, please focus on the following aspects:

  • Clarity and completeness of the assignment requirements
  • Rationale behind the technical choices (e.g., architecture, folder structure, tools used)
  • Suggestions to improve scalability, maintainability, or developer experience
  • Quality of Source Code written

Additional Areas to Explore

If applicable, feel free to check the following to enhance your review:

  • ERD — provided on the README.md
  • API Documentation — Access via Swagger UI (http://localhost:8080/swagger-ui/index.html#) after running the service
  • API Collections — Postman or Hoppscotch collections are included for easy endpoint testing

Your Feedback

Please share via raising an issue ticket or via email on the following:

  • What was clear and well-structured?
  • Areas that caused confusion or could be improved
  • Suggestions for better design, security, or documentation
  • Any other relevant recommendations

Thank you for your feedback! Your input will help strengthen my knowledge in SpringBoot & Java :)