We want to make contributing to Cooper as easy and transparent as possible.
Using pip
, you can install the package in development mode by running:
pip install --editable "[.dev]"
We test the package using pytest
, which you can run locally by typing
pytest tests
We actively welcome your pull requests.
- Fork the repo and create your branch from
master
. - If you've added code that should be tested, add tests.
- If you've changed APIs, update the documentation.
- Ensure the test suite passes.
- Make sure your code lints.
We use GitHub issues to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.
We use black
for formatting isort
for import sorting, flake8
for
linting. We ask for type hints for all code committed to Cooper and check
for compliance with mypy
. The CI system should check of this when you submit
your pull requests.
By contributing to Cooper, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.