# Contributing to TCRsift

We would love your help in making TCRsift a useful resource for the community. No contribution is too small, and we especially appreciate usability improvements like better documentation, tutorials, tests, or code cleanup.

## Making a contribution
All contributions can be made as pull requests on Github. One of the core developers will review your contribution. As needed the core contributors will also make releases and submit to PyPI.

A few other guidelines:

* TCRsift supports Python 3.9+ (see `pyproject.toml`). We primarily test on Linux and macOS.
* All functions should be documented using [numpy-style docstrings](https://numpydoc.readthedocs.io/en/latest/format.html) and associated with unit tests.
* Bugfixes should be accompanied with a test that illustrates the bug when feasible.
* Contributions are licensed under Apache 2.0
* Please adhere to our [code of conduct](code-of-conduct.md).

Working on your first Pull Request? One resource that may be helpful is [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github).
