Skip to content

Latest commit

 

History

History
29 lines (20 loc) · 887 Bytes

CONTRIBUTING.md

File metadata and controls

29 lines (20 loc) · 887 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 set up the service.
  6. Test the code and create a pull request.

Unit Tests

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

Some services may need extra dependencies to run tests. Example:

docker start test-redis || docker run --name test-redis -p 6379:6379 -d redis

Run test cases with Poetry and Pytest:

poetry run pytest