Skip to content

Peer review

Jump to bottom
luckasw edited this page Dec 17, 2024 · 2 revisions

Peer review

The code feels a bit cluttered, with functions like main_handler trying to handle too much at once, making it harder to read and maintain. Using global variables, such as authorizer, could lead to potential issues and makes the code less modular. Breaking down large functions into smaller, more focused ones and simplifying the logic would make the code cleaner and easier to work with.

Setup Issues (Debian System)

Backend

  • The backend didn’t work because there was no config.py file, even though the README mentioned it should be included.
  • There were limited instructions on how to create or set up the config.py file.
  • The README, while clear overall, didn’t provide enough details on backend setup.

Frontend

  • The frontend was easy to install and worked fine.

Suggestions

  1. Backend Setup:

    • Add a sample config.py file with proper instructions on customization.
    • Update the README to include detailed steps for backend setup and troubleshooting.

  2. Feature Clarification:

    • Clarify which features should work in the current version to set proper expectations.

  3. Collaborative Improvements:

    • Work with the team to resolve backend setup issues and improve documentation.

Acceptance Testing Feedback

  • We planned to check if the app’s features match the requirements, but backend setup issues blocked testing.
  • The frontend seemed functional and worked as expected.

Response

Based on the feedback, we have addressed key areas to improve the project. Below is a summary:

1. Code Structure

  • Tests have been moved out of the src/ directory.
  • Unnecessary commented-out code has been removed.
  • Modularized large enums for better readability.
  • Estonian comments have been replaced with English equivalents.

2. Functionality

  • Added more unit tests to improve coverage and validate syntax handling.
  • Clarified usage instructions, including compilation steps, in the project wiki.
  • Parsing error handling improved.

3. Documentation

  • Added an installation guide and expanded explanations in the wiki to improve clarity.
  • Provided clearer descriptions of the tool’s functionality.

Some issues, such as xml-builder integration, have been noted for future iterations.

Clone this wiki locally