As much as we love your support and contribution ! We want to make contributing to this project as easy and transparent as possible, whether it's:
- Reporting a bug
- Adding code submission
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
- Becoming a maintainer
We are currently using github to host code, to track issues and feature requests, as well as accept pull requests.
- Fork the repo and create your branch from
masterwith your username ❗❗ and this is the branch you should use to submit all your work to ensure organization . please do not deviate from this approve to make things easy for the team . - If you've added code that should be tested, add tests.
- If you've changed APIs, update the documentation.
- Ensure the test suite passes.
- 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.
We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!
This is an example of a bug report I wrote, and I think it's not a bad model. Here's another example from Craig Hockenberry
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)
People love thorough bug reports. I'm not even kidding.
I'm again borrowing these from Facebook's Guidelines
- 4 spaces for indentation rather than tabs
By contributing, you agree that your contributions will be licensed under its MIT License.
This document was adapted from the open-source contribution guidelines for Facebook's Draft