DEV Community
·
团队提交信息规范
💡
原文英文，约300词，阅读约需2分钟。
📝
内容提要
常规提交是一种标准化的提交信息格式。通过配置Git钩子，可以验证提交信息是否符合规定格式，从而在所有本地仓库中强制执行这一规范。
🎯
关键要点
- 常规提交是一种标准化的提交信息格式。
- 遵循这一规范可以实现整洁且易于阅读的提交历史。
- 创建Git钩子的目录：mkdir -p ~/.git-templates/hooks。
- 配置Git使用该目录：git config --global core.hooksPath ~/.git-templates/hooks。
- 创建commit-msg钩子并编写验证脚本。
- 使用正则表达式验证提交信息格式是否符合规范。
- 有效的提交信息示例包括：feat: 添加新用户引导流程，fix(api): 修正404响应的错误处理。
- 使钩子可执行：chmod +x ~/.git-templates/hooks/commit-msg。
- 现有仓库不会自动使用新的全局钩子，需要手动处理。
- 任何不符合正则检查的提交信息将中止提交并显示错误信息。
❓
延伸问答
什么是常规提交？
常规提交是一种标准化的提交信息格式，旨在实现整洁且易于阅读的提交历史。
如何配置Git钩子以强制执行提交信息规范？
可以通过创建目录并配置Git使用该目录来设置钩子，具体步骤包括：创建目录、配置hooksPath、创建commit-msg钩子并编写验证脚本。
有效的提交信息示例有哪些？
有效的提交信息示例包括：feat: 添加新用户引导流程，fix(api): 修正404响应的错误处理。
如何使commit-msg钩子可执行？
可以使用命令chmod +x ~/.git-templates/hooks/commit-msg来使commit-msg钩子可执行。
如果已有仓库，如何使用新的全局钩子？
已有仓库不会自动使用新的全局钩子，可以手动删除或重命名本地hooks文件夹，或手动复制/符号链接commit-msg钩子到每个仓库的hooks文件夹。
提交信息不符合规范会发生什么？
任何不符合正则检查的提交信息将中止提交，并显示错误信息，强制执行常规提交规范。
➡️
