Git Commit 提交规范
在团队协作中,合理的提交规范能够帮助开发者提高代码质量、简化代码审查流程,并促进更高效的团队协作。本文介绍 Git commit 提交规范的重要性,并分享一些最佳实践,帮助开发者更好地管理和记录代码提交。
一、常见的提交规范约定
一种较为常见且高效的提交信息规范是 Conventional Commits。这种规范定义了提交信息的结构和格式,能使得 Git 提交记录更加统一且有条理。
规范的格式为:
<类型>(<范围>): <简要描述>
[可选的详细描述]
★提交类型快查★
-
类型 (Type):标识提交的目的或类别,常见的类型有:
feat
: 新功能 (Feature)fix
: 修复问题 (Bug fix)docs
: 文档更新 (Documentation)style
: 代码格式化,无逻辑变更 (Styling)refactor
: 代码重构 (Refactor)test
: 增加或修改测试 (Test)chore
: 其他修改,如构建过程、依赖管理等 (Chore)perf
: 性能优化 (Performance)
-
范围 (Scope):可选项,用来说明提交影响的模块或组件,如
core
,api
,ui
,backend
等。 -
简要描述 (Subject):提交的简短说明,概括了本次提交所做的工作。
-
详细描述 (Bod