提交PR注意事项
切换到所建分支,然后点击 。
选择目标分支,在 PR 的描述说明中,填写 resolve #Issue编号
可以在这个 PR 被 merge 后,自动关闭对应的 Issue,具体请见这里。
接下来等待 review,如果有需要修改的地方,参照上述步骤更新 origin 中的对应分支即可。
您在Pull Request中每提交一次新的commit后,会触发CI单元测试,请确认您的commit message中已加入必要的说明,请见
请您关注您Pull Request中的CI单元测试进程,它将会在几个小时内完成
您仅需要关注和自己提交的分支相关的CI项目,例如您向develop分支提交代码,则无需关注release/1.1一栏是否通过测试
当所需的测试后都出现了绿色的对勾,表示您本次commit通过了各项单元测试
如果所需的测试后出现了红色叉号,代表您本次的commit未通过某项单元测试,在这种情况下,请您点击detail查看报错详情,并将报错原因截图,以评论的方式添加在您的Pull Request中,我们的工作人员将帮您查看
也可以使用 删除远程分支,如:
最后,删除本地分支。
至此,我们就完成了一次代码贡献的过程。
为了使评审人在评审代码时更好地专注于代码本身,请您每次提交代码时,遵守以下约定:
1)请保证Travis-CI 中单元测试能顺利通过。如果没过,说明提交的代码存在问题,评审人一般不做评审。
2)提交Pull Request前:
请注意commit的数量
原因:如果仅仅修改一个文件但提交了十几个commit,每个commit只做了少量的修改,这会给评审人带来很大困扰。评审人需要逐一查看每个commit才能知道做了哪些修改,且不排除commit之间的修改存在相互覆盖的情况。
请注意每个commit的名称:应能反映当前commit的内容,不能太随意。
3)如果解决了某个Issue的问题,请在该Pull Request的第一个评论框中加上:,这样当该PUll Request被合并后,会自动关闭对应的Issue。
此外,在回复评审人意见时,请您遵守以下约定:
1)评审人的每个意见都必须回复(这是开源社区的基本礼貌,别人帮了忙,应该说谢谢):
对评审意见同意且按其修改完的,给个简单的
Done
即可;对评审意见不同意的,请给出您自己的反驳理由。
2)如果评审意见比较多:
请给出总体的修改情况。