code团队代码约定式提交规范

info概述

约定式提交规范是一种轻量级的提交信息约定，它提供了一组简单规则来创建清晰的提交历史。本规范适用于团队中的 Git 和 SVN 版本控制系统。

star规范的优势

edit提交信息格式

architecture基本结构

<类型>[可选的作用域]: <描述>

[可选的正文]

[可选的脚注]

category1. 类型(必需)

scatter_plot2. 作用域(可选)

作用域用于说明本次提交影响的范围，建议使用项目中的模块名、组件名或功能域：

• user - 用户模块
• auth - 认证模块
• api - API接口
• ui - 用户界面
• db - 数据库
• config - 配置相关

description3. 描述(必需)

• 使用现在时态："添加功能" 而不是 "添加了功能"
• 首字母小写
• 句末不加句号
• 简洁明了，建议不超过50个字符

article4. 正文(可选)

• 详细说明本次提交的动机和变更内容
• 与描述部分空一行
• 每行不超过72个字符
• 说明为什么做这个变更，而不是做了什么

note5. 脚注(可选)

• 用于标注破坏性变更或关联issue
• 破坏性变更以 BREAKING CHANGE: 开头
• 关联issue使用 Closes #123 或 Fixes #456

code提交示例

# 新功能
feat(user): 添加用户头像上传功能

# 修复bug
fix(auth): 修复登录时密码长度验证错误

# 文档更新
docs: 更新项目README文档

# 重构
refactor(api): 重构用户信息获取接口

feat(payment): 支持微信支付

集成微信支付SDK，支持扫码支付和H5支付两种方式。
用户可以在订单页面选择微信支付完成付款。

Closes #234

feat(api): 更新用户API返回格式

BREAKING CHANGE: 用户API返回的数据结构发生变化，
原来的 user_name 字段改为 username，
原来的 user_id 字段改为 id

account_tree提交流程图

以下流程图展示了约定式提交的标准流程：

tips_and_updates最佳实践

build工具集成

# 全局安装
npm install -g commitizen cz-conventional-changelog

# 配置
echo '{ "path": "cz-conventional-changelog" }' > ~/.czrc

# 使用 - 替代 git commit
git cz

# 安装
npm install --save-dev @commitlint/config-conventional @commitlint/cli

# 配置 commitlint.config.js
module.exports = {
  extends: ['@commitlint/config-conventional']
}

# Git hook 集成
npx husky add .husky/commit-msg 'npx --no-install commitlint --edit $1'

# 安装
npm install --save-dev standard-version

# 配置 package.json
{
  "scripts": {
    "release": "standard-version"
  }
}

# 发布新版本
npm run release

rocket_launch团队实施建议

school培训和文档

• groups组织团队培训会议，讲解规范的重要性和使用方法
• library_books将规范文档加入团队知识库
• link在项目README中链接到此规范
• quiz定期组织规范使用情况检查和讨论

help常见问题

link参考资料

• open_in_new约定式提交规范官网
• open_in_newAngular提交信息规范
• open_in_new语义化版本规范