Skip to content

Latest commit

 

History

History
executable file
·
91 lines (57 loc) · 3.19 KB

CONTRIBUTING.md

File metadata and controls

executable file
·
91 lines (57 loc) · 3.19 KB
Raw

Contributing to Sentinel

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.

Before you get started

Code of Conduct

Please make sure to read and observe our Code of Conduct.

Setting up your development environment

You should have JDK 17 or later installed in your system.

How to run test

  1. add ~/.m2/toolchains.xml, to define JDK and path. See toolcahinas-example.xml.
  2. With JDK 17 as your default JDK, you could specify the JDK version to run test,

i.e. Run test at JDK 8:

mvn test -Dsurefire.jdk-toolchain-version=8

Contributing

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.

GitHub workflow

We use the master branch as the development branch, which indicates that this is a unstable branch.

Here are the workflow for contributors:

  1. Fork to your own
  2. Clone fork to local repository
  3. Create a new branch and work on it
  4. Keep your branch in sync
  5. Commit your changes (make sure your commit message concise)
  6. Push your commits to your forked repository
  7. Create a pull request

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.

Open an issue / PR

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.

Code review

All code should be well reviewed by one or more committers. Some principles:

  • Readability: Important code should be well-documented. Comply with our code style.
  • Elegance: New functions, classes or components should be well designed.
  • Testability: Important code should be well-tested (high unit test coverage).

Community

Contact us

Mailing list

If you have any questions or advice, please contact [email protected].

Gitter

Our Gitter room: https://gitter.im/alibaba/Sentinel.