Thanks for taking the time to contribute! We want to make contributing to this project as easy and transparent as possible, whether it's:
If you would like to tailor any particular part of this repository to fit your team needs specificaly, it is recomended that you fork and clone this to make breaking changes.
- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
- Becoming a maintainer
If you encounter a bug, please check if the bug has already been reported. If the bug has not been reported, you can report the bug by opening a new issue
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)
You can contribute by adding additional information to existing issues.
You can contribute by validating an issue or adding additional context to an existing issue.
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.
- If you've changed APIs, update the documentation.
- Ensure the test suite passes.
- Make sure your code lints.
- Issue that pull request!
By contributing, you agree that your contributions will be licensed under its Apache 2.0 license.