5月18

Conventional Commits 常见规范

| |
16:53运维管理  From: 本站原创
`git feat` 是指在 Git 提交(commit)信息中使用 `feat` 作为前缀,它是英文 “feature”(新功能)的缩写,用于标识本次提交新增了一个功能或特性。

这一用法源于 [Conventional Commits(约定式提交)](https://www.conventionalcommits.org/) 规范,该规范通过标准化提交信息格式,提升团队协作效率,并便于自动生成变更日志(changelog)和版本号管理。

---

常见提交类型前缀含义

- `feat`:新增功能(feature)  
  示例:`feat: 添加用户登录功能`
- `fix`:修复 bug  
  示例:`fix: 修复登录超时问题`
- `docs`:仅修改文档  
  示例:`docs: 更新 README 使用说明`
- `style`:代码样式调整(不影响运行)  
  示例:`style: 格式化代码缩进`
- `refactor`:代码重构(非新增功能、非修复 bug)  
  示例:`refactor: 提取用户验证逻辑为独立函数`
- `chore`:构建过程或工具依赖更新  
  示例:`chore: 更新 npm 依赖包`
- `test`:增加或修改测试  
  示例:`test: 添加登录接口单元测试`

---

提交信息结构(Conventional Commits)

标准格式为:

```
():
[body]
[footer]
```

- `type`:必须,如 `feat`、`fix` 等  
- `scope`:可选,限定影响范围,如 `(auth)`、`(api)`  
- `subject`:简短描述(≤50 字符)  
- `body` / `footer`:可选,详细说明或关联 issue

示例完整写法:

```bash
feat(auth): 添加 Google OAuth 登录支持

- 允许用户通过 Google 账号一键登录
- 集成 OAuth2.0 流程
- 关联 JIRA-123
```

---

实践意义

- ✅ 提高可读性:团队成员快速理解提交目的  
- ✅ 支持自动化:工具(如 `semantic-release`)可依据 `feat` 自动升级版本号  
- ✅ 便于生成 changelog:按类型分类生成发布说明  

更多规范细节可参考:[Conventional Commits 官方规范](https://www.conventionalcommits.org/)

来源:Heck's Blog
地址:https://www.heckjj.com/post/685/
转载时须以链接形式注明作者和原始出处及本声明,否则将追究法律责任,谢谢配合!
阅读(8) | 评论(0) | 引用(0)