We actively welcome your pull requests.
- Fork the repo and create your branch from
master. - Add tests if necessary.
- Update the documentation if necessary.
- Run the test suite to ensure tests pass.
- Make sure your code lints with
black.
Clone the repo & install the development requirements:
git clone https://github.com/banditml/banditml.git
cd banditml
banditml uses pipenv to manage its environment.
pipenv install --python 3.7
You're good to go!
To run all unit tests:
pipenv run python -m unittest
To run unit tests for one module:
pipenv run python -m unittest tests.banditml.serving.test_predictor
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.
By contributing to Bandit ML, you agree that your contributions will be licensed under the COPYING file in the root directory of this source tree.