How-to-contribute.md

贡献

欢迎来到OpenEdge百度开源边缘计算项目，如果您想要向OpenEdge贡献代码或文档，请遵循以下流程。

贡献流程

OpenEdge使用通用的Git 分支构建模型。下面将为您提供通用的Github代码贡献方式。

1. Fork代码库

   我们的开发社区非常活跃，感兴趣的开发者日益增多，因此，我们鼓励开发者采用“fork”方式向我们提交代码。关于如何fork一个代码库，请参考Github提供的官方帮助页面并点击"Fork" 按钮.

2. 准备开发环境

   如果您想要向OpenEdge贡献代码，请参考如下命令准备相关本地开发环境：

   go get github.com/baidu/openedge # 获取openedge代码库
   cd $GOPATH/src/github.com/baidu/openedge # 进入openedge代码库目录
   git checkout master  # 校验当前处于master主分支
   git remote add fork https://github.com/<your_github_account>/openedge  # 指定远程提交代码仓库

3. 提交代码到fork仓库

   这里，将改动的需求或修复的bug提交到步骤2中fork的远程仓库，具体请参考如下命令：

   git status   # 查看当前代码改变状态
   git add .
   git commit -c "modify description"  # 提交代码到本地仓库，并提交代码改动描述信息
   git push fork # 推送已提交本地仓库的代码要远程仓库

4. 创建代码合入请求

   基于fork的仓库地址直接向OpenEdge官方仓库https://github.com/baidu/openedge提交pull request（具体请参考如何创建一个提交请求），即可完成向OpenEdge官方仓库的代码合入请求。一旦OpenEdge代码仓库评审人员通过了您的代码提交、合入请求，您即可在OpenEdge官方代码仓库中看到您贡献的代码。

代码评审规范

• Golang的代码风格请参照Go Code Review Comments
• 请在代码CI测试通过后及时通过Email向你的代码评审人发送代码提交请求URL
• 请及时回答评审人的每一个comment，如果您采纳评审人给出的建议，请直接回复“好的”或是“Done”；如果您不同意，请给出您的理由
• 如果您不想您的代码评审人被邮件通知频繁打扰，您可以通过“交互框”回复评审人提出的每一个建议，具体请参考如何使用交互框回复评审人信息
• 尽可能减少不必要的代码提交。一些开发者总是频繁提交代码。如果您想要向提交的代码中增加一个微小的改动，请使用命令git commit --amend代替git commit

代码合入规范

无规矩不成方圆。这里规定，凡是提交OpenEdge代码合入请求的代码，一律要求遵循以下规范：

• 建议您提交代码前再次执行命令govendor fmt +local，具体请参考govendor
• 代码提交前必须进行单元测试（提交代码应包含）和竞争检测，参考执行命令make test
• 仅有提交代码通过单元测试和竞争检测，才允许向OpenEdge官方仓库提交
• 所有向OpenEdge官方仓库提交的代码，必须至少有1个代码评审员评审通过后，才可以将提交代码合入OpenEdge官方代码仓库

注意：以上所有代码提交步骤要求及规范，同样适用文档贡献。