Skip to content

PR 提交规范

Jump to bottom
rk edited this page May 25, 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对应一个功能

angular 规范

建议使用 angular 规范，描述更准确，可以使用 cz-cli 等工具辅助生成 commit log。

<类型>(范围): 标题
<空行>
<主体描述>
<空行>
<额外描述>

feat(ci): 支持一键发版

1. 支持根据最新 release 自动递推版本号
2. 支持传入指定版本号

Breaking changes：
工作流 publish_chart 不再支持手动触发，可以通过 publish_release 触发。

closed #666

支持的类型（必填）：

  • feat (新特性)
  • fix (bug 修复)
  • docs (文档)
  • style (格式)
  • refactor（重构）
  • test (测试)
  • chore (其他)

支持的范围（可自定义，可为空）：

  • api
  • cluster
  • backup
  • user
  • chart
  • ci
  • e2e

如果 commit 可能对之前的功能有影响，请在额外描述中补充说明。

commit 相关的 issue 序号需要在额外描述中补充。

Clone this wiki locally