commit规范

Commit是Git中用于记录代码更改的基本单元。一个良好的commit应该包含足够的信息,使得其他开发者可以理解更改的目的和内容。

Commit规范的主要目的是确保每次提交都是原子性的、可理解的,并且与项目其他部分的更改无关。这有助于维护清晰的项目历史记录,便于未来的代码审查和问题定位。

  • 原子性:每次提交应该只包含一个逻辑上的改变。这使得每个提交都是独立的,并且易于理解和回滚。
  • 描述清晰:提交信息应当简明扼要地说明此次更改的目的或解决了什么问题。通常包括: -- 动词开头(如添加、修复、更新等) -- 使用现在时态 -- 限制每行长度(建议72字符以内)
  • 结构化信息:有些团队会采用特定格式来组织提交信息,例如Angular团队的提交规范,它包括类型(type)、作用范围(scope)和主题(subject),如 feat(module): add new functionality

推荐示例

feat:添加用户认证功能

新的用户身份验证功能允许用户使用电子邮件和密码登录。
此提交包括对用户模型、身份验证控制器和视图的更改。

修复#456
  • 标题清晰地说明了提交的目的。
  • 正文提供了足够的细节,使得其他开发者可以理解更改的上下文。
  • 关联了相关的issue,使得问题追踪和代码审查更加容易

关于commit message的更多信息,可以参考Commit message规范