在团队协作中使用 Git 进行版本控制时,遵循一定的提交规范是非常重要的。这不仅有助于其他开发者快速理解代码变更,还可以提高代码库的整洁性和可维护性。
规范概述
- 每次提交都包含一个有意义的提交信息。
- 提交信息应简洁明了,不超过 50 个字符。
- 使用英文进行提交信息。
- 提交信息格式为
<type>(<scope>): <subject>
。
提交类型
类型 | 描述 |
---|---|
fix |
修复错误 |
feat |
添加新功能 |
docs |
文档更新 |
style |
代码格式、无逻辑变动 |
refactor |
代码重构 |
test |
测试 |
chore |
构建过程或辅助工具的变动 |
提交范围
提交范围用于描述提交影响的文件或模块。例如:fix: update README.md
。
示例
git commit -m "fix: 修复了页面加载错误"
扩展阅读
想要了解更多关于 Git 提交规范的信息,可以阅读Git 提交规范详解。
Git 标准化提交流程图