Skip to content

Latest commit

 

History

History
29 lines (18 loc) · 899 Bytes

CONTRIBUTING.md

File metadata and controls

29 lines (18 loc) · 899 Bytes

Contribution Guide

Bug Reports

For bug reports submit an issue.

Pull Requests

  1. Fork the main repository
  2. Create a feature branch to hold your changes
  3. Work on the changes in your feature branch
  4. Add Unit Tests
  5. Follow the Getting Started instruction to setup service.
  6. Create the alembic migration environment only when it's needed
  7. Test the code and create pull request

Migrations

To create new migration with alembic.

   docker compose run --rm alembic revision -m "Migration name"

Unit Tests

When adding a new feature or fixing a bug, unit test is necessary to write. Currently we adopted pytest as our testing framework and all test cases are written under tests directory

  1. Run test cases.

    poetry run pytest