Welcome to Sentinel! This document is a guideline about how to contribute to Sentinel. If you find something incorrect or missing, please leave comments / suggestions.
Please make sure to read and observe our Code of Conduct.
You should have JDK 1.8 or later installed in your system.
We are always very happy to have contributions, whether for typo fix, bug fix or big new features. Please do not ever hesitate to ask a question or send a pull request.
We strongly value documentation and integration with other projects. We are very glad to accept improvements for these aspects.
We use the
master branch as the development branch, which indicates that this is a unstable branch.
Here are the workflow for contributors:
Please follow the pull request template. Please make sure the PR has a corresponding issue.
After creating a PR, one or more reviewers will be assigned to the pull request. The reviewers will review the code.
Before merging a PR, squash any fix review feedback, typo, merged, and rebased sorts of commits. The final commit message should be clear and concise.
We use GitHub Issues and Pull Requests for trackers.
If you find a typo in document, find a bug in code, or want new features, or want to give suggestions, you can open an issue on GitHub to report it. Please follow the guideline message in the issue template.
If you want to contribute, please follow the contribution workflow and create a new pull request. If your PR contains large changes, e.g. component refactor or new components, please write detailed documents about its design and usage.
Note that a single PR should not be too large. If heavy changes are required, it's better to separate the changes to a few individual PRs.
All code should be well reviewed by one or more committers. Some principles:
If you have any questions or advice, please contact firstname.lastname@example.org.
Our Gitter room: https://gitter.im/alibaba/Sentinel.