Welcome to EventMesh! This document is a guideline about how to contribute to EventMesh. If you find something incorrect or missing, please leave comments / suggestions.
You should have JDK installed in your develop environment.
Import EventMesh CheckStyle file to your IDE.
For IDEA, you can import check style file by:
Editor -> Code Style -> Java -> Scheme -> Import Scheme -> CheckStyle ConfigurationIf you can't see CheckStyle Configuration section under Import Scheme, you can install CheckStyle-IDEA plugin first, and you will see it.
You can also use ./gradlew check to check the code style.
(NOTE: this command will check all file in project, when you submit a pr, the ci will only check the file has been changed in this pr).
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 develop branch as the development branch, which indicates that this is an unstable branch.
Here are the workflow for contributors:
- Fork to your own
- Clone fork to local repository
git clone [email protected]:yourgithub/incubator-eventmesh.git
- Create a new branch and work on it
git checkout -b fix_patch_xx
- Keep your branch in sync
git remote add upstream [email protected]:apache/incubator-eventmesh.git
git fetch upstream develop:upstream_develop
git rebase upstream_develop
- Commit your changes (make sure your commit message concise)
- Push your commits to your forked repository
- Create a pull request
Please follow the pull request template. Please make sure the PR has a corresponding issue. GitHub Issues
After creating a PR, one or more committers will help to review the pull request, after approve, this PR will be merged in to EventMesh repository, and the related Issue will be closed.
We use GitHub Issues and Pull Requests for trackers.
If you 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. Your PR title should start with [ISSUE #xx]. If your PR contains large changes, e.g. component refactor or new components, please write detailed documents about its design and usage.
If your change is about a typo or small optimize, you needn't create an Issue, just submit a PR and title with [MINOR].
[Note]: A single pull request 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:
- 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).
EventMesh follows Apache License 2.0 policy. All source files should have the Apache License header added to the file header. EventMesh uses the apache/skywalking-eyes to check the source file header.
EventMesh uses check-dependencies.sh script to check for third-part dependencies. When you need to add a three-part dependency, you need to register the newly added dependency in tool/license/known-dependencies.txt. The newly added three-part libraries need to meet ASF 3RD PARTY LICENSE POLICY. It is highly recommended communicating with EventMesh community before you need to add a three-part library.
After a PR is approved by at least one committer, it can be merged. Before the merge, the committer can make changes to the commits message, requiring the commits message to be clear without duplication, and use Squash and Merge to make sure one PR should only contain one commits. For large multi-person PR, use Merge to merge, and fix the commits by rebase before merging.
Mail: [email protected]