Git生态探索之Commit message 和 Change log 编写最佳实践

简介: 背景最近在学习规范如何使用git来更高效的开发,发现一个比较好用的来规范comment的工具,所以想来记录一下。一般来说,commit message 应该清晰明了,说明本次提交的目的。所以需要一些规范来使这些comment变得可读,commitizen则是最近发现的一款比较易用的工具。

背景
最近在学习规范如何使用git来更高效的开发,发现一个比较好用的来规范comment的工具,所以想来记录一下。一般来说,commit message 应该清晰明了,说明本次提交的目的。所以需要一些规范来使这些comment变得可读,commitizen则是最近发现的一款比较易用的工具。

git的提交一般的初学者都会使用git commit -m "hello world"来提交comment,但是一些像hello world这样没有意义的comment让人无法理解这次的提交到底是为了什么,所以我们就要规范一下comment的规范了。

PS:下面是一些基础介绍如果大佬请直接查看第二部分

  1. commit message format(信息域)
  2. message一般分为三个部分Header,Body 和 Footer

():
// 空一行

// 空一行

其中,Header 是必需的,Body 和 Footer 可以省略

Example:
PS D:gitpythonPractice> git log
commit 58a7a966acb9aa2fffc0e02c9ce3be64b8949991 (HEAD -> master)
Author: Zhiwei Tian hebeitianzhiwei@outlook.com
Date: Fri Aug 17 17:38:36 2018 +0800

feat(serve): add grpc server

1.1 HEAD
type用于说明 commit 的类别,只允许使用下面7个标识
feat:新功能(feature)
fix:修补bug
docs:文档(documentation)
style: 格式(不影响代码运行的变动)
refactor:重构(即不是新增功能,也不是修改bug的代码变动)
test:增加测试
chore:构建过程或辅助工具的变动

scope 用来说明本次Commit影响的范围,即简要说明修改会涉及的部分,比如数据层、控制层、视图层等,
subjectcomment所在的位置,这次提交的简短描述
1.2 Body 是对本次 commit 的详细描述,可以分成多行
1.3 Footer 部分只用于两种情况
不兼容变动
如果当前代码与上一个版本不兼容,则 Footer 部分以BREAKING CHANGE开头,后面是对变动的描述、以及变动理由和迁移方法

关闭 Issue
如果当前 commit 针对某个issue,那么可以在 Footer 部分关闭这个 issue (可依次关闭过个issueCloses #123, #245, #992)

1.4 Revert
还有一种特殊情况,如果当前 commit 用于撤销以前的 commit,则必须以revert:开头,后面跟着被撤销 Commit 的 Header

revert: type(scope): some comment
This reverts commit bfe307ce57d87677c6c473c228e6c2ed8b81dcec.

Body部分的格式是固定的,必须写成This reverts commit <hash>.,其中的hash是被撤销 commit 的 HSHA 标识符。
如果当前 commit 与被撤销的 commit,在同一个发布(release)里面,那么它们都不会出现在 Change log 里面。如果两者在不同的发布,那么当前 commit,会出现在 Change log 的Reverts小标题下面

  1. 使用commitizen来执行规范
    因为commitizen是node的模块,所以前提需要安装node(官网下载地址)

全局安装commitizennode模块
npm install -g commitizen

在项目目录下运行命令
commitizen init cz-conventional-changelog --save --save-exact

此时可能会报找不到package.json的错误,使用下面命令来自动生成一个项目的package,然后在运行2中的命令.
npm init --yes

运行完以上一律使用git cz 代替git commit来提交代码,同时会显示一下选项来自动生成符合格式的commit message.

PS D:gitpythonPractice> git cz
cz-cli@2.10.1, cz-conventional-changelog@2.1.0

Line 1 will be cropped at 100 characters. All other lines will be wrapped after 100 characters.

? Select the type of change that you're committing: (Use arrow keys)

feat: A new feature

fix: A bug fix
docs: Documentation only changes
style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
refactor: A code change that neither fixes a bug nor adds a feature
perf: A code change that improves performance
test: Adding missing tests or correcting existing tests
(Move up and down to reveal more choices)

按照提示,你可以写出规范的message了
idea有插件可以使用git commit template

commitizen同时可以检查commit message是否符合格式.
生成change log,还又一些高级用法比如ghooks
这里就不细说了.详细请查看参考链接和validate-commit-msg

现在项目中可能多出来dir:node_nodules, file:package.json, package-lock.json这些目录和文件,这是node安装模块产生的,如果不是node项目都可以忽略掉,熟悉node的同学肯定都知道哪些是有用的了.

相关实践学习
通过日志服务实现云资源OSS的安全审计
本实验介绍如何通过日志服务实现云资源OSS的安全审计。
相关文章
|
5月前
|
Prometheus 监控 Java
日志收集和Spring 微服务监控的最佳实践
在微服务架构中,日志记录与监控对系统稳定性、问题排查和性能优化至关重要。本文介绍了在 Spring 微服务中实现高效日志记录与监控的最佳实践,涵盖日志级别选择、结构化日志、集中记录、服务ID跟踪、上下文信息添加、日志轮转,以及使用 Spring Boot Actuator、Micrometer、Prometheus、Grafana、ELK 堆栈等工具进行监控与可视化。通过这些方法,可提升系统的可观测性与运维效率。
561 1
日志收集和Spring 微服务监控的最佳实践
|
4月前
|
存储 缓存 数据处理
71_数据版本控制:Git与DVC在LLM开发中的最佳实践
在2025年的大模型(LLM)开发实践中,数据和模型的版本控制已成为确保项目可重复性和团队协作效率的关键环节。与传统软件开发不同,LLM项目面临着独特的数据版本控制挑战:
|
5月前
|
负载均衡 监控 安全
5 个 IIS 日志记录最佳实践
IIS日志记录是监控Web服务器性能与安全的关键。本文介绍启用日志、应用池配置、负载均衡、敏感数据防护、日志集中管理及保留策略等五大最佳实践,助力高效分析与合规审计。
374 1
|
7月前
|
API 开发工具 git
使用git pull遇到Automatic merge failed; fix conflicts and then commit the result.解决方案卓伊凡
使用git pull遇到Automatic merge failed; fix conflicts and then commit the result.解决方案卓伊凡
415 0
使用git pull遇到Automatic merge failed; fix conflicts and then commit the result.解决方案卓伊凡
|
9月前
|
监控 容灾 算法
阿里云 SLS 多云日志接入最佳实践:链路、成本与高可用性优化
本文探讨了如何高效、经济且可靠地将海外应用与基础设施日志统一采集至阿里云日志服务(SLS),解决全球化业务扩展中的关键挑战。重点介绍了高性能日志采集Agent(iLogtail/LoongCollector)在海外场景的应用,推荐使用LoongCollector以获得更优的稳定性和网络容错能力。同时分析了多种网络接入方案,包括公网直连、全球加速优化、阿里云内网及专线/CEN/VPN接入等,并提供了成本优化策略和多目标发送配置指导,帮助企业构建稳定、低成本、高可用的全球日志系统。
995 54
|
7月前
|
开发工具 git
使用Git下载指定版本或指定commit
使用Git下载指定版本或指定commit
|
8月前
|
存储 人工智能 缓存
Git Commit规范:为什么有些公司要求变更行数限制?·优雅草卓伊凡
Git Commit规范:为什么有些公司要求变更行数限制?·优雅草卓伊凡
357 3
Git Commit规范:为什么有些公司要求变更行数限制?·优雅草卓伊凡
|
11月前
|
人工智能 前端开发 Java
用git rebase命令合并开发阶段中多条commit提交记录
通过 `git rebase`,可以合并多个提交记录,使开发历史更简洁清晰。操作分为 6 步:查看提交历史 (`git log --oneline`)、设置需合并的提交数 (`git rebase -i HEAD~N`)、修改动作标识为 `s`(squash)、保存退出编辑、调整提交信息、强制推送至远程仓库 (`git push -f`)。此方法适合清理本地无关提交,但若有团队协作或冲突风险,需谨慎使用以避免问题。
1927 60
|
9月前
|
JavaScript 前端开发 持续交付
实际工作中 Git Commit 代码提交规范是什么样的?
实际工作中 Git Commit 代码提交规范是什么样的?
831 7