How to Contribute

Features or Bug Fixes

Create a python virtual environment

With conda:

$ conda env create -f requirements/dev.yml
$ conda activate rts

With python:

$ python -m venv venv
$ . venv/bin/activate
$ pip install -r ./requirements/dev.txt

Install the project into the virtual environment:
```
$ pip install -e .
```
Setup pre-commit hooks
```
$ pre-commit install
```
Create your development branch:
```
$ git checkout -b my-dev-branch
```
Run the tests and fix anything that broke:
```
$ pytest
```
(Optional) Run pre-commit to find/fix any formatting and flake8 issues:
```
$ pre-commit run --all-files
```
This will run isort, black, and flake8 on the repo's files. It is recommended to do this and fix any errors that are flagged so that the changes can be cleanly commited.

Commit your changes to your branch and push to your remote repo:

$ git add .
$ git commit -m "A detailed description of the changes."
$ git push origin my-dev-branch