git commit message——git提交日志规范备忘

简介: 使用git提交时,最好能注意保持规范,可能某些公司对这方面没有要求,但是提交日志不规范的话,不方便查阅和管理。在此记录下commit的类别,备忘,更详细的介绍,可以查看文末链接。

commit message格式说明

Commit message一般包括三部分:Header、Body和Footer。


1. Header

type(scope):subject

type:用于说明commit的类别,规定为如下几种

feat:新增功能;

fix:修复bug;

del: 删除

docs:修改文档;

refactor:代码重构,未新增任何功能和修复任何bug;

build:改变构建流程,新增依赖库、工具等(例如webpack修改);

style:仅仅修改了空格、缩进等,不改变代码逻辑;

perf:改善性能和体现的修改;

chore:非src和test的修改;

test:测试用例的修改;

ci:自动化流程配置修改;

revert:回滚到上一个版本;

scope:【可选】用于说明commit的影响范围

subject:commit的简要说明,尽量简短


2. Body

对本次commit的详细描述,可分多行


3. Footer

不兼容变动:需要描述相关信息


关闭指定Issue:输入Issue信息


相关实践学习
日志服务之使用Nginx模式采集日志
本文介绍如何通过日志服务控制台创建Nginx模式的Logtail配置快速采集Nginx日志并进行多维度分析。
相关文章
|
3天前
|
人工智能 数据可视化 开发工具
Git log 进阶用法(含格式化、以及数据过滤)
Git log 进阶用法(含格式化、以及数据过滤)
|
1月前
|
存储 监控 Cloud Native
|
3月前
|
开发工具 git
git日志输出相关命令
git日志输出相关命令
|
5月前
|
开发工具 git
vscode 查看git提交日志
vscode 查看git提交日志
262 0
|
1月前
|
弹性计算 开发工具 git
如何创建符合计算巢规范的Git仓库
为了简化软件云化部署,阿里云计算巢提供了一站式平台,开发者仅需将自己的git仓库配置为符合计算巢服务规范,即可实现自动化部署到云端。官方提供了多个模板,涵盖不同架构和部署物类型,便于开发者从计算巢官方仓库fork并定制。重要文件包含config.yaml和,用于配置服务构建参数。通过计算巢控制台,即可完成服务的创建和发布,实现软件的云上部署。
|
2月前
|
Shell 开发工具 git
查看 Git 中某个文件的提交历史记录(log)
要查看 Git 中某个文件的提交历史记录(log),你可以使用 `git log` 命令并指定文件名作为参数。以下是一些常用的方法来查看某个文件的 Git log: 1. **查看文件的完整提交历史**: ```bash git log -- <filename> ``` 这里的 `--` 是可选的,用于分隔命令行选项和文件名。 2. **查看文件的简要提交历史**: ```bash git log --oneline -- <filename> ``` --oneline` 选项会以一行显示每个提交,使输出更简洁。 3. **查看文件的提交历史并显示每次提交的差异**: ```
100 0
|
3月前
|
前端开发 测试技术 持续交付
【开发规范】Git Commit 规范
【1月更文挑战第26天】【开发规范】Git Commit 规范
|
3月前
|
数据可视化 测试技术 持续交付
Git Flow规范在工作中的使用流程
Git Flow规范在工作中的使用流程
39 0
|
3月前
|
JavaScript 测试技术 持续交付
2020你应该知道的git commit规范
2020你应该知道的git commit规范
89 0
|
4月前
|
设计模式 程序员 Go
Git操作不规范,战友提刀来相见!
Git操作不规范,战友提刀来相见!