同步操作将从 WeBank/eventmesh 强制同步,此操作会覆盖自 Fork 仓库以来所做的任何修改,且无法恢复!!!
确定后同步将在后台操作,完成时将刷新页面,请耐心等待。
欢迎使用EventMesh! 本文档是有关如何为EventMesh做出贡献的指南。 如果发现不正确或缺失的内容,请留下评论/建议。
您应该在开发环境中安装了JDK。
将 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上提出或者通过邮件列表进行讨论。
我们非常重视文档以及与其他项目的集成,我们很高兴接受这些方面的改进。
我们将develop
分支用作开发分支,这表明这是一个不稳定的分支。
这是贡献者的工作流程 :
git clone git@github.com:yourgithub/incubator-eventmesh.git
git checkout -b fix_patch_xx
git remote add upstream git@github.com:apache/incubator-eventmesh.git
git fetch upstream develop:upstream_develop
git rebase upstream_develop
请遵循Pull Requests模板. 请确保PR对应有相应的问题. GitHub Issues
创建PR后,社区会有committer成员帮助review,review通过之后,PR将会合并到主库,相应的Issue会被关闭。
我们将使用Issues和Pull Requests作为跟踪器
如果您发现新的Bug,想要新功能或提出新当建议,您可以在GitHub上创建Issue ,请按照Issue模板中的准则进行操作。 如果您在文档中发现拼写错误,或者发现代码中存在可以进行微小的优化的地方,您可以无需创建Issue, 直接提交一个PR。
如果您想贡献,请遵循贡献工作流程并创建一个新的拉取请求。 如果您的PR包含较大的更改,例如组件重构或新组件,请写详细文档 有关其设计和使用的信息。 对于PR的标题请依照[ISSUE #xx]进行开头,如果是细小的改动请以[MINOR]进行开头。
【注意】: 单个PR不应太大。如果需要进行重大更改,最好将更改分开 到一些个人PR。
所有PR应由一个或多个committer进行良好的审查。一些原则:
EventMesh遵循Apache License 2.0 政策。 所有的源代码文件应该在文件头部添加Apache License header,EventMesh会使用apache/skywalking-eyes 对源代码文件头进行校验。
EventMesh使用check-dependencies.sh脚本 检查第三方依赖,当你需要添加三方依赖时,你需要将新添加的依赖注册在tool/license/known-dependencies.txt中, 同时新添加的三方库需要满足Apache对于第三方的政策。
当添加依赖时遇到问题时,社区PPMC会协助解决,非常建议在需要添加三方依赖之前与EventMesh社区进行沟通。
PR经过至少一个committer approve之后会由committer负责合并,在合并的时候,committer可以对commits信息进行修改,要求commits信息简洁明了,不重复。 在合并时使用Squash and merge, 要求一个PR保留一个commits。对于大型多人协助的PR,使用Merge进行合并,在合并之前通过rebase修正commits。
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。