掌握撰写有效Git提交消息的艺术

4,419 阅读2分钟

编写提交消息没有严格的规则,但必须清晰简洁地传达您所做的更改。一种方法是在提交消息中使用关键字。

这些关键词或标签有助于指明更改的性质,并使其他人更容易理解你贡献的背景。

以下是一些常见的关键词以及它们所表示的内容:

FEAT

使用此关键字表示您正在致力于一项新功能。

FEAT: Add new login functionality.

FIX

使用此关键字表示您正在为特定问题提交修复。

FIX: Fix bug causing crashes on certain devices.

STYLE

使用此关键字表示您正在更改代码的样式或格式,但不更改其功能。

STYLE: Update indentation in main.js.

REFACTOR

使用此关键字表示您正在对代码进行更改,以改善其结构或组织,但不要添加新功能或修复错误。

REFACTOR: Refactor the code to improve readability.

TEST

使用此关键字表示您正在添加或更新代码的测试。

TEST: Add new unit tests for login functionality.

CHORE

使用此关键字表示您正在更改构建过程或其他与代码本身没有直接关系的任务。

CHORE: Update dependencies in package.json.

PERF

使用此关键字表示您正在进行更改以提高代码的性能。

PERF: Optimize image loading for faster performance.

CI

使用此关键字来表示您正在对持续集成过程进行更改。

CI: Fix issue with test pipeline on Dashboard CI.

BUILD

使用此关键字来指示您正在对构建过程进行更改。

BUILD: Add new script for building the production version of the app.

Squashing Git提交更干净的提交历史记录

可以使用 git rebase -i 命令在 Git 中完成挤压提交。

git log

首先,使用 git log 检查提交历史记录,以确定您想在壁球中包含多少提交

16740919044139

git rebase -i

使用 git rebase -i HEAD~n,其中 “n” 是提交数量。在这种情况下,我们希望包含最后3个提交,因此我们将使用 git rebase -i HEAD~3

git rebase -i HEAD~3

pick replace squash

这将打开一个文本编辑器,显示要压制的提交,每行开头都有“选择”一词。将“pick”一词替换为“squash”,表示您想要挤压的提交。

16740919951645

输入新的提交信息并存储文件。现在,指定的提交将被挤压为带有新提交消息的单个提交。

开启掘金成长之旅!这是我参与「掘金日新计划 · 2 月更文挑战」的第 5 天,点击查看活动详情