Thank you for considering contributing to MLtraq! MLtraq is an actively maintained and constantly improved project that serves a diverse user base with varying backgrounds and needs. This document will guide you through the process of contributing to the project.
Feel free to drop your thoughts and questions in the Discussions - a place to connect with other members of our community.
To get started, follow these steps:
-
Fork the mltraq repository and clone it to your local machine.
-
Install poetry to manage dependencies and packaging.
-
Install virtual environment and dependencies:
cd mltraq poetry install --all-extras --sync -
Run the tests:
poetry run pytest
When you're ready to contribute, follow these steps:
- Create an issue describing the feature, bug fix, or improvement you'd like to make.
- Create a new branch in your forked repository for your changes.
- Write your code and tests.
- Test, format, and lint your code by running
pytest. - Create a pull request targeting the
develbranch of the main repository.
We use devel (which is our default Github branch) to prepare a next release of mltraq. We accept all regular contributions there (including most of the bugfixes).
We use main branch for hot fixes (including documentation) that needs to be released out of normal schedule.
On the release day, devel branch is merged into main. All releases of mltraq happen only from the main.
pyenv versions # List Python versions and available environments
pyenv install 3.9:latest # Install Python version
poetry env use 3.9.18
poetry add pytest@latest --group dev