如何贡献代码

[ZhuoZhuoCrayon]

提交信息

commit message

${commit_type}: ${commit_msg}

需满足以下正则（之一）：

^(refactor|feat|perf|optimize|fix|docs|test|build|style)\(front\):(.*)"

^(feature|docs|bugfix|optimization|refactor|test):(.*)

commit_type: 提交类型

• feature - 新特性
• bugfix - 线上功能bug
• minor - 不重要的修改（换行，拼写错误等）
• optimization - 功能优化
• refactor - 功能重构
• test - 增加测试代码
• docs - 编写文档

commit_msg: 提交信息

一般情况下，提交都是关联 Github Issue，非常建议在 commit-msg 中显式的声明或关闭 issue

声明或关闭 issue (${action} #${issue_id})

• action:

  • 可为空，表示该 issue 还未完结
  • 对于不同的 commit_type，做如下约束：
    • commit_type != bugfix - close closes closed
    • commit_type == bugfix - fix fixes fixed resolve resolves resolved
  • action 不为空的情况下，当该 commit 合入主分支时，GitHub 会关闭相应的 issue，你可以参考：https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue

• issue_id: 在提交代码前，应该先在 Github 创建 issue，简要记录背景和解决方案

下面简单给一个样例

git commit -m "feature: 插件包管理支持对象存储模式 (closed #2)"

# git log
# feature: 插件包管理支持对象存储模式 (closed #2)

提交分支

当前主分支为 GitHub 的默认分支，例如 v2.3.x

PR 的目标分支为，与默认分支主版本号/次版本号一致的，修订号最大的开发分支，例如 v2.3.1-dev

自动生成版本日志

基于 Release Changelog Builder 自动对提交信息进行去重，只要提交信息满足上述要求，即可在版本发布时记录到版本日志：https://github.com/marketplace/actions/release-changelog-builder

项目提交信息转换规则，参考：https://github.com/TencentBlueKing/bk-nodeman/blob/v2.3.x/.github/configuration.json