Contributing Guide#

We are striving to build an open and inclusive community around UnionML. Whether you are a novice or experienced software developer, data scientist, or machine learning practitioner, all contributions and suggestions are welcome!

Ways to Contribute#

There are many ways to contribute to this project:

  • ๐Ÿ“– Improve the documentation: See typos and grammatical errors? Open up a PR to fix them!

  • ๐Ÿž Report Bugfixes: Coming up against unexpected behavior? Open up an issue!

  • ๐Ÿ™ Feature Requests: Have ideas on new features or improvements? Open up an issue!

  • ๐Ÿ”ง Pull Requests: Pick up one of the issues in the issue log and submit a PR!

Roadmap#

Roadmap OSS Planning

The release roadmap is a living being ๐ŸŒณ, so you can also participate in roadmapping and prioritization!

Each milestone in the roadmap is made up of multiple issues, and you can upvote roadmap items by going to the issue page and giving it a thumbs up ๐Ÿ‘.

The UnionML maintainers hold a bi-weekly open source sync up and re-prioritize the roadmap based on community interest, so subscribe to the google calendar event by clicking on the โ€œOSS Planningโ€ badge above if youโ€™re interested in joining.

Development Environment Setup#

Create a virtual environment:

python -m venv ~/venvs/unionml
source activate ~/venvs/unionml/bin/activate

Install dependencies:

pip install -r requirements-dev.txt

pre-commit Setup#

This project uses pre-commit to ensure code standards. Follow the installation instructions, then setup the pre-commit hooks:

pre-commit install

Make sure everything is working correctly by running:

pre-commit run --all

Run Unit Tests#

Finally, to make sure your development environment is ready to go, run the unit tests:

pytest tests/unit

Run Integration Tests [Optional]#

Optionally, you can run integration tests locally. First install flytectl, then:

python tests/integration