Skip to content

Latest commit

 

History

History
90 lines (62 loc) · 4.18 KB

CONTRIBUTING.zh-CN.md

File metadata and controls

90 lines (62 loc) · 4.18 KB

贡献给EventMesh

欢迎使用EventMesh! 本文档是有关如何为EventMesh做出贡献的指南。 如果发现不正确或缺失的内容，请留下评论/建议。

开始之前

设置您的开发环境

您应该在开发环境中安装了JDK。

Code Style

将 EventMesh CheckStyle 文件导入开发者工具。如果你使用IDEA，你可以通过以下步骤导入：

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

如果你在Import Scheme下看不到CheckStyle Configuration选项，你可以先安装CheckStyle-IDEA插件，然后你就可以看到这个选项了。

你也可以通过执行./gradlew check来检查代码格式。(NOTE: 这个命令将会检查整个项目中的代码格式， 当你提交一个PR时，CI只会检查在此次PR中被被修改的文件的代码格式)

贡献

无论是对于拼写错误，BUG修复还是重要的新功能，我们总是很乐意接受您的贡献。请不要犹豫，在Github Issue上提出或者通过邮件列表进行讨论。

我们非常重视文档以及与其他项目的集成，我们很高兴接受这些方面的改进。

GitHub工作流程

我们将develop分支用作开发分支，这表明这是一个不稳定的分支。

这是贡献者的工作流程 :

  1. Fork到您个人仓库
  2. 克隆到本地存储库
git clone git@github.com:yourgithub/incubator-eventmesh.git
  1. 创建一个新分支并对其进行处理
git checkout -b fix_patch_xx
  1. 保持分支与主库同步
git remote add upstream git@github.com:apache/incubator-eventmesh.git
git fetch upstream develop:upstream_develop
git rebase upstream_develop
  1. 提交您的更改(确保您的提交消息简明扼要)
  2. 将您的提交推送到分叉的存储库
  3. 创建PR合并请求

请遵循Pull Requests模板. 请确保PR对应有相应的问题. GitHub Issues

创建PR后，社区会有committer成员帮助review，review通过之后，PR将会合并到主库，相应的Issue会被关闭。

打开问题/ PR

我们将使用Issues和Pull Requests作为跟踪器 GitHub Issues Pull Requests

如果您在文档中发现拼写错误，在代码中发现错误，想要新功能或提出建议， 您可以提出问题在GitHub上打开问题 请按照问题模板中的准则消息进行操作。

如果您想贡献，请遵循贡献工作流程并创建一个新的拉取请求。 如果您的PR包含较大的更改，例如组件重构或新组件，请写详细文档 有关其设计和使用的信息。

请注意，单个拉取请求不应太大。如果需要进行重大更改，最好将更改分开 到一些个人PR。

代码审查

所有代码应由一个或多个committer进行良好的审查。一些原则:

  • 可读性: 重要代码应有详细记录。符合我们的代码风格
  • 优雅: 新功能，类或组件应经过精心设计
  • 可测试性: 重要代码应经过良好测试（较高的单元测试覆盖率）

License审查

EventMesh遵循Apache License 2.0 政策。 所有的源代码文件应该在文件头部添加Apache License header，EventMesh会使用apache/skywalking-eyes 对源代码文件头进行校验。EventMesh使用Gradle-License-Report插件 检查第三方依赖，当你需要添加三方依赖时，你需要将新添加的依赖注册在tool/license/allowed-licenses.txt中，你可以通过执行./gradlew clean checkLicense命令可以判断当前是否有license尚未添加， 同时新添加的三方库需要满足Apache对于第三方的政策。 非常建议在需要添加三方依赖之前与EventMesh社区进行沟通。

社区

联系我们

邮件：dev@eventmesh.apache.org