Contribution Guide

Contributions to pycoare of all forms are welcome!

Please follow these guidelines for contributing to this project:

• Fork the pycoare repository into your local GitHub repository

• Clone your forked repository to your local machine

$ git clone <url_to_your_forked_repository>
$ cd coare

• Install the development requirements using uv and activate the virtual environment

$ uv sync --dev
$ .venv/bin/activate

• Create a new branch for your feature

$ git checkout -b my-new-feature

• Install the pre-commit hooks for code formatting

$ pre-commit install

• Make your changes and commit them

$ git commit -am 'Add some feature'

• Push to the branch

$ git push origin my-new-feature

• Create a new Pull Request on GitHub (a good title and description are helpful!)

• A maintainer will review your changes and merge them into the main branch!