# Contributing
We want to make contributing to this project as easy and transparent as
possible.

## Pull Requests
We actively welcome your pull requests.

1. Fork the repo and create your branch from `develop`.
2. If you've added code that should be tested, add tests.
3. If you've changed APIs, update the documentation.
4. Ensure the test suite passes.
5. Make sure your code lints.

## Testing
From the project root, execute the following:
```bash
make test
```


## Linting
```bash
make lint
```

## Building docs

```bash
cd docs
make html
```


## Issues
We use [GitHub issues](https://github.com/LukasHedegaard/continual-inference/issues) to track public bugs. Please ensure your description is
clear and has sufficient instructions to be able to reproduce the issue.


## License
By contributing to Continual Inference, you agree that your contributions will be licensed
under the [LICENSE](https://github.com/LukasHedegaard/continual-inference/blob/main/LICENSE) file in the root directory of this source tree.