Contributing to InferTrade

Found a new feature, or a bug? We welcome your pull requests.

Licencing

Contributions should be consistent with the Apache 2.0 licence and with the principles of the Developer Certificate of Origin.

Submit an issue describing your proposed change to the repo in question.
The repo owner will respond to your issue promptly and the community can provide feedback.
If your proposed change is accepted, fork infertrade.
```
git@github.com:ta-oliver/infertrade.git
```

Set up developer mode.

cd infertrade/
make dev-venv
source .inferlib_venv/bin/activate

Make changes, and test your code changes. You may use make for testing your code.
- Run tests:
```
make test
```
- Check code coverage:
```
make coverage
```
Ensure that your code adheres to the existing style within InferTrade. Refer to the Google Style Guide if unsure. We recommend you use
```
make autoformat
```
This will lint with the black package with 120 char lines setting (black -l 120 infertrade).
Ensure that your code has an appropriate set of unit tests which all pass.
If this is your first pull request, please add yourself to the list of project copyright contributors.
Submit a pull request.