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
We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.
We use Github Flow
We use GitHub Flow, so all changes happen via pull requests.
Pull requests are the best way to propose changes to the codebase (we use Github Flow). We actively welcome your pull requests:
- Fork the repo and create your branch from
master
. - 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!
Report bugs or request features using Github Issues
We use GitHub issues to track public bugs. Report a bug by opening a new issue.
This repository is using eslint
to enforce styling convention. Refer to the .eslintrc
file for more information.
By contributing, you agree that your contributions will be licensed under its BSL 1.1 License.