This document is inspired by elasticsearch/CONTRIBUTING.md
Adding a CONTRIBUTING.md to a Github repository enables a link to that file in the pull request or create an issue page. This document should guide potential contributors toward making a successful and meaningful impact on the project, and can save maintainers time and hassle caused by improper pull requests and issues. You can learn more about the features that are enabled by Github when this file is present here.
There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting Github issues, bug reports, feature requests and writing code.
This repository uses the The Apache License, Version 2.0.
If you think you've found a bug in the software, first make sure you're testing against the latest version of the software -- your issue may have been fixed already. If it's not, please check out the issues list on Github and search for similar issues that have already been opened. If there are no issues then please submit a Github issue.
If you can provide a small test case it would greatly help the reproduction of a bug, as well as a a screenshot, and any other information you can provide.
If there are features that do not exist yet, we are definitely open to feature requests and detailed proposals. Open an issue on our Github which describes the feature or proposal in detail, answer questions like why? how?
Bug fixes, patches and new features are welcome. Please find or open an issue about it first. Talk about what exactly want to do, someone may already be working on it, or there might be some issues that you need to be aware of before implementing the fix.
There are many ways to fix a problem and it is important to find the best approach before writing a ton of code.
For small documentation changes and fixes, these can be done quickly following this video guide on how to contribute to Open Source in 1 minute on Github.
- Review & Test changes
- If the code changed, then test it. If documentation changed, then preview the rendered Markdown.
- Commiting
- Follow the Conventional Commits guidelines to create a commit message.
- Sign the CLA
- Make sure you've signed the repository's Contributor License Agreement. We are not asking you to assign copyright to us, but to give us the right to distribute your code without restriction. We ask this of all contributors in order to assure our users of the origin and continuing existence of the code. You only need to sign the CLA once.
- Submit a pull request
- Push local changes to your forked repository and make a pull request. Follow the Convention Commits guidelines for naming Github pull requests and what to put in the body.
Follow the build process is outlined in BUILDING.md to create a build.
Follow the release process is outlined in RELEASING.md to create a release.