Skip to content

Git 提交规范

COMMIT_CONVENTION.md

遵循 Angular 提交规范

提交信息格式

bash
<type>(<scope>): <subject>

<body>

<footer>

Type 类型

类型描述
feat新功能
fixbug 修复
docs仅文档更改
style不影响代码含义的更改(空白、格式、缺少分号等)
refactor既不修复 bug 也不添加功能的代码更改
perf提高性能的代码更改
test添加缺失的测试或纠正现有测试
build构建系统或外部依赖的更改
ciCI 配置文件和脚本的更改
chore其他不修改 src 或 test 文件的更改
revert回滚之前的提交

Scope 范围(可选)

范围可以是任何指定提交更改位置的内容,例如:

  • cli - CLI 相关
  • template - 模板相关
  • build - 构建相关
  • docs - 文档相关

Subject 主题

  • 使用现在时态:"change" 而不是 "changed" 或 "changes"
  • 不要大写首字母
  • 末尾不要加句号

示例

基本示例

bash
feat: 添加 Vue3 模板支持
fix: 修复项目名称验证问题
docs: 更新 README 安装说明
style: 统一代码格式
refactor: 重构模板配置逻辑

带范围(scope)的示例

bash
feat(cli): 添加 --template 选项
fix(template): 修复 Next.js 模板配置
docs(readme): 添加使用示例
chore(deps): 更新依赖版本

带描述体的示例

bash
feat: 添加交互式模板选择

- 使用 inquirer.js 实现交互式界面
- 支持键盘导航选择模板
- 自定义主题颜色

Closes #123

BREAKING CHANGE

如果提交包含破坏性更改,需要在 footer 中说明:

bash
feat: 重新设计 CLI 参数

BREAKING CHANGE: --override 选项已重命名为 --force

基于 MIT 许可发布