Skip to content

Latest commit

 

History

History
63 lines (51 loc) · 2.42 KB

how-to-contribute.zh.md

File metadata and controls

63 lines (51 loc) · 2.42 KB
Raw

如何提交代码

一、fork 分支

在浏览器中打开 MegFlow, fork 到自己的 repositories，例如

https://github.com/user/MegFlow

clone 项目到本地，添加官方 remote 并 fetch:

$ git clone https://github.com/user/MegFlow && cd MegFlow
$ git remote add megvii https://github.com/MegEngine/MegFlow
$ git fetch megvii

对于 git clone 下来的项目，它现在有两个 remote，分别是 origin 和 megvii

$ git remote -v
origin   https://github.com/user/MegFlow (fetch)
origin   https://github.com/user/MegFlow (push)
megvii  https://github.com/MegEngine/MegFlow (fetch)
megvii  https://github.com/MegEngine/MegFlow (push)

origin 指向你 fork 的仓库地址；remote 即官方 repo。可以基于不同的 remote 创建和提交分支。

例如切换到官方 master 分支，并基于此创建自己的分支（命名尽量言简意赅。一个分支只做一件事，方便 review 和 revert）

$ git checkout MegEngine/master
$ git checkout -b my-awesome-branch

或创建分支时指定基于官方 master 分支：

$ git checkout -b fix-typo-in-document MegFlow/master

git fetch 是从远程获取最新代码到本地。如果是第二次 pr MegFlow git fetch megvii 开始即可，不需要 git remote add megvii，也不需要修改 github.com/user/MegFlow。

二、代码习惯

为了增加沟通效率，reviewer 一般要求 contributor 遵从以下规则

  • 不能随意增删空行
  • tab 替换为 4 个空格
  • 若是新增功能或平台，需有对应测试用例
  • 文档放到docs目录下，中文用.zh.md做后缀；英文直接用.md后缀

开发完成后提交到自己的 repository

$ git commit -a
$ git push origin my-awesome-branch

推荐使用 commitizen 或 gitlint 等工具格式化 commit message，方便事后检索海量提交记录

三、代码提交

浏览器中打开 MegFlow pulls ，此时应有此分支 pr 提示，点击 Compare & pull request

  • 标题必须是英文。未完成的分支应以 WIP: 开头，例如 WIP: fix-typo
  • 正文宜包含以下内容，中英不限
    • 内容概述和实现方式
    • 功能或性能测试
    • 测试结果

回到浏览器签署 CLA，所有 CI 测试通过后通知 reviewer merge 此分支。