- Every new functionality should be accompanied with solid unit tests. We haven't set any threshold regarding code coverage % as we want to be pragmatic.
- Every bug that is fixed should come with related unit tests.
- Regarding coding style, we follow PEP8 by leveraging black
- Standard Fork & Pull Request Workflow is used in this project
- Every new functionality should be created in a branch (from main branch) with name format
feature/new-functionality-name - Every bug should be fixed in a branch (from main branch) with name format
fix/bug-name - All branches will be merged to main branch
- Poetry is used as a dependency management tool
- Run
poetry install --with devto install dependencies - Ready to rock!
poetry run pytest --cov .: Runs tests with code coverage
poetry run black . --checkto check if there's a formatting issuepoetry run black .to fix the formatting issue