We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
- Becoming a maintainer
- manuscript: only upload a pdf or a TeX compiled pdf. Do not upload the source files.
- code: unless necessary, please upload scripts only (not notebook).
- data: upload public data only. If the data contains personal information, please remove it.
We Use Github Flow, So All Code Changes Happen Through Pull Requests
Pull requests are the best way to propose changes to the codebase.
- Fork the repo and create your branch from
master
. - If you've added code that should be tested, add tests.
- Make sure your code lints.
- Issue that pull request!
In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.
Report bugs using Github's issues
We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!
By contributing, you agree that your contributions will be licensed under its MIT License.