Commit Message 规范

简介: Commit Message 规范

目前 Commit Message 规范比较常见的有 Angular 团队的规范,并由此衍生出了 Conventional Commits Specification,可以参照此 Specification 约定 Commit Message 格式规范。

<type>(<scope>): <subject><BLANK LINE><body><BLANK LINE><footer>

大体分三行:

【标题行】必填, 描述主要修改类型和内容。

【主题内容】描述为什么修改, 做了什么样的修改, 以及这么做的思路等等。

【页脚注释】放 Breaking Changes 或 Closed Issues

其中 type 是 Commit 的类型,可以有以下取值

type
feat 新特性
fix 修改 bug
refactor 代码重构
docs 文档更新
style 代码格式修改
test 测试用例修改
chore 其他修改, 比如构建流程, 依赖管理

其中 scope 表示的是 Commit 影响的范围,比如 ui,utils,build 等,是一个可选内容。

其中 subject 是 Commit 的概述,body 是 Commit 的具体内容。

fix: correct minor typos in codesee the issue for details on typos fixed.Refs #133

Commit Message 可以在 git 中配置模板,这样可以在 vim 中展示出模板,另外可有工具帮助我们生成和约束 Commit Message,例如 commitizen/cz-cli


相关文章
|
开发工具 git 编译器
Git 提交的正确姿势:Commit message 编写指南
Git 每次提交代码,都要写 Commit message(提交说明),否则就不允许提交。 $ git commit -m "hello world" 上面代码的-m参数,就是用来指定 commit mesage 的。
7148 0
|
4月前
|
中间件
|
3月前
|
IDE 开发工具 git
我是怎么写 Git Commit message 的?
我是怎么写 Git Commit message 的?
52 0
|
6月前
|
网络安全 开发工具 git
git修改提交路径以及强制提交——异常:error: remote origin already exists.与异常:error: failed to push some refs to的解决
git修改提交路径以及强制提交——异常:error: remote origin already exists.与异常:error: failed to push some refs to的解决
80 0
|
6月前
|
存储 JSON Java
gitlab配置hook,commit message的时候校验提交的信息
gitlab配置hook,commit message的时候校验提交的信息
540 0
|
运维 前端开发 中间件
Go 项目分层下的最佳 error 处理方式
本文对 Go 项目分层下的最佳 `error` 处理方式进行介绍,并通过使用 github.com/pkg/errors 库中的一些实用函数来提供实现示例。
158 1
Go 项目分层下的最佳 error 处理方式
|
前端开发 JavaScript Shell
手写 git hooks 脚本(pre-commit、commit-msg)
手写 git hooks 脚本(pre-commit、commit-msg)
482 0
|
前端开发 开发工具 git
优雅提交 Git Commit Message
那么如何能优雅而又不失体面的提交你的代码呢?其实我们的 `git commit message` 是应该具备一些规范的。目前规范用的比较多的是 Angular 团队规范
125 0
|
前端开发 测试技术 持续交付
gitHooks: commit-msg
gitHooks: commit-msg
171 0
|
缓存 Oracle 关系型数据库
Oracle中控制commit的三个参数 commit_write, commit_logging和 commit_wait
Oracle中控制commit的动作有三个参数 commit_write, commit_logging和 commit_wait,按重要性分别说明如下
285 0