Contributing¶
Signals is an open-source project and we welcome suggestions, questions, and code.
Report bugs, issues, and feature requests to the Github issue tracker.
Recommended Setup¶
- Fork and clone your own copy of the Signals Github repo
- Create a new python virtual environment
pip install -r requirements.txt
pip install -r dev-requirements.txt
Run Tests¶
- To run the tests, just run
nosetests
.
Submitting Changes¶
- Open a pull request from your Github repo to
/yeti/signals/master
- Provide an overview of your changes
- Specify any issues (by number) that your PR addresses
- Open a pull request from your Github repo to
PRs won’t be merged if they break tests
Feel free to ask for help or guidance!