Development Process

Development Process

This project follows the general development guidelines outlined in the VR4VET project.

• Agile Workflow: See Agile Workflow in VR4VET
• Coding Conventions: See Coding Conventions
• Naming Conventions: See Naming convention

Local Development

(Add details specific to setting up and running the chat-service locally, e.g., Python version, dependencies, virtual environments, running tests.)

You can find dependencies in requirements.txt.

Testing

Tests are located in the tests/ directory and can be run using pytest. See pytest.ini for configuration. Key test files:

• test_embeddings.py
• test_dao.py
• test_document_upload.py
• test_endpoints.py

Test Reporting

While detailed test execution reports are typically managed as part of the continuous integration and testing workflow, the format for such reports, especially for functional and quality requirements, is outlined in the Test Report Template. This template guides the documentation of test specifics, including requirement IDs, tester, date, duration, evaluation, and other relevant metrics for quality attribute testing.

Contribution Guidelines

• Create issues for new features or bugs.
• Follow the branching strategy (e.g., feature branches from develop).
• Submit Pull Requests for review.