Skip to content

PR 提交规范

rk edited this page May 18, 2022 · 3 revisions

PR 流程

  1. 创建 issue,描述你遇到的问题,期望的解决方案(如果有)。

  2. Fork 官方仓库。

  3. 克隆fork后的仓库到本地。

  4. 创建本地分支,推荐一次PR创建一个新的分支,在分支上commit。

  5. 推送分支到远端。

  6. 提交PR,申请合并你的分支到官方仓库的main分支。

Commit 规范

  1. commit格式应遵循如下约束:

    1. 格式为 <修改的包名>: <commit 描述> <issue的序号>

    2. 如果在一个commit中修改了多个包,则包名应填写 *

    3. 如果改动的内容不属于任何包,则包名应填写为文件名或文件夹名。

    示例1,修复了mysqlcluster包的一个bug。
     mysqlcluster: fix xxxxx. #666
    
    示例2,修改了多个包
     *:support mysql8. #666
    
    示例3,更新了README.md文件。
     README: update README.md. #666
    
  2. 一个commit对应一个功能

Clone this wiki locally