使用提交规范(Commit Conventions)在版本控制系统中有多个重要的好处,包括提高代码的可维护性、协作效率以及自动化工作流程等。
在 Git 中,提交规范(Commit Conventions)主要是指遵循一套预定义的规则来编写提交信息。这有助于提高代码的可维护性和团队的协作效率,使版本历史更加清晰和一致。常见的提交规范包括 Conventional Commits 和 Angular Commit Guidelines 等。
本文主要介绍如何在 Xcode 中进行使用提交规范模板以及目前自己使用觉得很有意思的提交规范进行分享。
提交模板
[type] <description>
[optional body]
[optional footer]
type: 提交类型
[Feature] - 主要是开发新的新的功能或者特性时进行使用
[Patch] --- 生产环境中产生 BUG 时进行修复时使用
[Bug] ----- 非生产环境下修复 Bug
[Clean] --- 主要日常任务中进行使用,可以是写完成了什么任务或者完成某部分模块,或者引入什么新的依赖等等、
[Release] - 发版时候进行使用
示例:
[Clean] 更新目前项目的依赖,处理依赖关系以及更新国际化包
主要处理新增韩语支持.
@普通市民 2024.08.17
使用 Git Comment Template
可以在 .gitmessage 文件中定义提交模板来规范化提交信息。将该文件放在仓库根目录或全局 Git 配置中:
# .gitmessage
<type>(<scope>): <description>
[optional body]
[optional footer]
然后在 Git 配置中指定该模板:
git config --global commit.template ~/.gitmessage
感谢阅读,欢迎共同交流👏