代码提交指南

贡献途径

IoTDB 诚邀广大开发者参与开源项目构建

您可以查看 issues 并参与解决，或者做其他改善。

提交 pr，通过 Travis-CI 测试和 Sonar 代码质量检测后，至少有一位以上 Committer 同意且代码无冲突，就可以合并了

PR 指南

在 Github 上面可以很方便地提交 Pull Request (PR)，下面将以本网站项目 apache/iotdb 为例（如果是其他项目，请替换项目名 iotdb）

Fork 仓库

进入 apache/iotdb 的 github 页面 ，点击右上角按钮 Fork 进行 Fork

配置 git 和提交修改

• 将代码克隆到本地：

git clone https://github.com/<your_github_name>/iotdb.git

请将 <your_github_name> 替换为您的 github 名字

clone 完成后，origin 会默认指向 github 上的远程 fork 地址。

• 将 apache/iotdb 添加为本地仓库的远程分支 upstream：

cd  iotdb
git remote add upstream https://github.com/apache/iotdb.git

• 检查远程仓库设置：

git remote -v
origin https://github.com/<your_github_name>/iotdb.git (fetch)
origin    https://github.com/<your_github_name>/iotdb.git(push)
upstream  https://github.com/apache/iotdb.git (fetch)
upstream  https://github.com/apache/iotdb.git (push)

• 新建分支以便在分支上做修改：（假设新建的分支名为 fix）

git checkout -b fix

创建完成后可进行代码更改。

• 提交代码到远程分支：（此处以 fix 分支为例）

git commit -a -m "<you_commit_message>"
git push origin fix

更多 git 使用方法请访问：git 使用，这里不赘述。

Git提交注意事项

在Git上提交代码时需要注意：

• 保持仓库的整洁：

  • 不要上传二进制文件，保证仓库的大小只因为代码字符串的改动而增大。

  • 不要上传生成的代码。

• 日志要有含义：

  • 题目用jira编号：[IOTDB-jira号]

  • 题目用github的ISSUE编号：[ISSUE-issue号]

    • 内容里要写#XXXX用于关联

创建 PR

在浏览器切换到自己的 github 仓库页面，切换分支到提交的分支 <your_branch_name> ，依次点击 New pull request 和 Create pull request 按钮进行创建，如果您解决的是 issues，需要在开头加上 [IOTDB-xxx]，如下图所示：

至此，您的 PR 创建完成，更多关于 PR 请阅读 collaborating-with-issues-and-pull-requests

冲突解决

提交 PR 时的代码冲突一般是由于多人编辑同一个文件引起的，解决冲突主要通过以下步骤即可：

1：切换至主分支

git checkout master

2：同步远端主分支至本地

git pull upstream master

3：切换回刚才的分支（假设分支名为 fix）

git checkout fix

4：进行 rebase

git rebase -i master

此时会弹出修改记录的文件，一般直接保存即可。然后会提示哪些文件出现了冲突，此时可打开冲突文件对冲突部分进行修改，将提示的所有冲突文件的冲突都解决后，执行

git add .
git rebase --continue

依此往复，直至屏幕出现类似 rebase successful 字样即可，此时您可以进行往提交 PR 的分支进行更新：

git push -f origin fix

这个指导文档修改于 Apache ServiceComb