git提交规范

Git提交规范是确保代码历史可读性和团队协作效率的重要实践,以下是核心规范:

一、提交信息格式规范

标准结构

<type>(<scope>): <subject>
<空行>
<body>
<空行>
<footer>

Header(必填):包含提交类型(type)、作用域(scope,可选)、简短描述(subject)。
Body(可选):详细说明改动动机、对比旧逻辑,或标记破坏性变更(如BREAKING CHANGE)。
Footer(可选):关联Issue或说明重大变更影响。

提交类型(Type)

类型 用途

	feat	 新增功能
	fix	     修复Bug
	docs	 文档更新
	style	 代码格式调整(如空格、缩进)
	refactor 代码重构(不涉及功能变更)
	perf	 性能优化
	test	 测试用例修改或新增
	build	 构建工具或依赖变更(如Webpack配置)
	chore	 其他杂项(如.gitignore调整)
	revert	 撤销某次提交

其他要求

字符限制:每行不超过72或100字符,避免自动换行。
时态与语态:使用祈使语气(如"Fix"而非"Fixed")。

二、分支管理规范(补充)

主分支:master/main(生产环境)、develop(开发环境)。
临时分支:feature/xxx(新功能)、fix/xxx(Bug修复)。
命名原则:清晰描述功能或问题(如feat/user-login)。

三、示例

feat(auth): 新增用户登录验证功能 
 
- 实现JWT Token生成与校验 
- 添加用户角色权限控制 
 
BREAKING CHANGE: 废弃旧版Session验证方式 
Closes #123 

通过规范提交,团队可高效生成CHANGELOG、回溯问题,并提升代码审查效率。

你可能感兴趣的:(git提交规范)