大家好!最近很长时间没有更新了,由于加入新团队新的项目组参与新的工作,导致博客创造搁置了一段时间,今天来记录一下我最近学习到的规范。
怎么写出符合 Angular 规范的 Commit Message 呢?
这是我们团队规定的规范。主要元素如下图所示
当我在开发过程中变更了应用代码,比如某个 Go 函数代码,那这次的修改属于代码类。在代码类
中,有 4 种具有明确变更意图的类型:feat、fix、perf 和 style;如果我们的代码变更不
属于这 4 类,那就全都归为 refactor 类,也就是优化代码。Angular 的 Commit Message 规范提供了大部分的 type,在实际开发中,我们可以使用
部分 type,或者扩展添加我们自己的 type。但无论选择哪种方式,我们一定要保证一个项
目中的 type 类型一致。
举一个我最近提交代码的例子吧!
feat(authentication): add JWT token authenticationAdd JWT token authentication feature to improve security for user login process.
在这个示例中:
feat
表示这是一个新特性的提交。(authentication)
是指该提交涉及到的功能模块或者部分,这里是认证部分。add JWT token authentication
是对这次提交所做的具体描述,清晰地说明了新增的功能。
按照 Angular 规范,提交信息的格式通常为:
<type>(<scope>): <subject>
<type>
表示提交的类型,可以是feat
、fix
、docs
等。<scope>
是可选的,表示这次提交影响到的范围或者模块。<subject>
是提交的简要描述,描述了这次提交所做的具体变更。
这种格式的提交信息使得代码库的提交历史更加清晰可读,并且有助于团队成员快速理解每次变更的目的和影响。
好了,以上就是我最近在团队开发中学习到的开发规范,经过这段时间的磨砺,提升了自己真正的开发经验,能够高效配合团队开发出优秀的代码。