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
You can use Github issues to communicate with us. If you require more real time and frequent back and forth, we recommend joining our slack channel. You can request access by filling this form
We use github to host code, to track issues and feature requests, as well as accept pull requests.
All Code Changes Happen Through Pull Requests Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:
- Fork the repo and create your branch from
master. - If you've changed APIs, update the documentation.
- Issue that pull request!
In short, when you submit code changes, your submissions are understood to be under the same GPL 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!
Great Bug Reports tend to have:
- A quick summary and/or background
- Steps to reproduce
- Be specific!
- Give sample code if you can. My stackoverflow question includes sample code that anyone with a base R setup can run to reproduce what I was seeing
- What you expected would happen
- What actually happens
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
tbd
By contributing, you agree that your contributions will be licensed under its GPL License.
This document was adapted from the open-source contribution guidelines for Facebook's Draft