Everything you need to know to contribute efficiently to the project.
This project uses the following integrations to ensure proper codebase maintenance:
- Github Worklow - run jobs for package build and coverage
As a contributor, you will only have to ensure coverage of your code by adding appropriate unit testing of your code.
Whether you encountered a problem, or you have a feature suggestion, your input has value and can be used by contributors to reference it in their developments. For this purpose, we advise you to use GitHub issues.
First, check whether the topic wasn't already covered in an open / closed issue. If not, feel free to open a new one! When doing so, use issue templates whenever possible and provide enough information for other contributors to jump in.
If you are wondering how to do something with tawazi, or a more general question, you should consider checking out GitHub discussions. See it as a Q&A forum, or the tawazi-specific StackOverflow!
Install all additional dependencies with the following command:
poetry install --with devand hook pre-commit
poetry run pre-commit install- Code: ensure to provide docstrings to your Python code. In doing so, please follow Google-style so it can ease the process of documentation later.
- Commit message: please follow Udacity guide
In order to run the same unit tests as the CI workflows, you can run unittests locally:
poetry run pytestTo run all quality checks together (static type-checking, linting, formatting, import order, and additional quality checks)
poetry run pre-commit run -a