Skip to content

Latest commit

 

History

History
100 lines (71 loc) · 4.41 KB

CONTRIBUTING.md

File metadata and controls

100 lines (71 loc) · 4.41 KB

Contributing to EventMesh

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.

Before you get started

Setting up your development environment

You should have JDK installed in your develop environment.

Code style

Import EventMesh CheckStyle file to your IDE.

For IDEA, you can import check style file by:

Editor -> Code Style -> Java -> Scheme -> Import Scheme -> CheckStyle Configuration

If 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).

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 develop branch as the development branch, which indicates that this is an unstable branch.

Here are the workflow for contributors:

  1. Fork to your own
  2. Clone fork to local repository
git clone [email protected]:yourgithub/incubator-eventmesh.git
  1. Create a new branch and work on it
git checkout -b fix_patch_xx
  1. 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
  1. Commit your changes (make sure your commit message concise)
  2. Push your commits to your forked repository
  3. 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.

Open an issue / PR

We use GitHub Issues and Pull Requests for trackers.

If you find a typo in a 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 pull request 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).

License review

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, and EventMesh uses Gradle-License-Report plugin 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/allowed-licenses.txt, you can execute ./gradlew clean checkLicense to judge whether there exist dependencies have been added, and 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.

Community

Contact us

Mail: [email protected]