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
We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.
We've tagged some issues to make it easy to get started 😄 Good first issues
If you're interested in working on an issue, make sure it has either a good-first-issue or up-for-grabs label added. Add a comment on the issue and wait for the issue to be assigned before you start working on it. This helps to avoid multiple people working on similar issues.
We Use GitHub Flow, So All Code Changes Happen Through Pull Requests
Pull requests are the best way to propose changes to the codebase (we use Git-Flow). We actively welcome your pull requests:
- Fork the repo and create your branch from
develop. Please create the branch in the format feature/- (eg: feature/176-chart-widget) - 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 AGPL v3 License that covers the project.
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.
- 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)
By contributing, you agree that your contributions will be licensed under its AGPL v3 License.
Contact us on Slack or mail us at [email protected].