diff --git a/docs/tools/Git.md b/docs/tools/Git.md index b6329f87..d6dc1de7 100644 --- a/docs/tools/Git.md +++ b/docs/tools/Git.md @@ -13,6 +13,7 @@ - [Git 使用快速入门](#git-使用快速入门) - [获取 Git 仓库](#获取-git-仓库) - [记录每次更新到仓库](#记录每次更新到仓库) + - [一个好的 Git 提交消息](#一个好的-Git-提交消息) - [推送改动到远程仓库](#推送改动到远程仓库) - [远程仓库的移除与重命名](#远程仓库的移除与重命名) - [查看提交历史](#查看提交历史) @@ -143,6 +144,17 @@ Git 有三种状态,你的文件可能处于其中之一: 6. **移除文件** :`git rm filename` (从暂存区域移除,然后提交。) 7. **对文件重命名** :`git mv README.md README`(这个命令相当于`mv README.md README`、`git rm README.md`、`git add README` 这三条命令的集合) +### 一个好的 Git 提交消息 +一个好的 Git 提交消息如下: + + 标题行:用这一行来描述和解释你的这次提交 + + 主体部分可以是很少的几行,来加入更多的细节来解释提交,最好是能给出一些相关的背景或者解释这个提交能修复和解决什么问题。 + + 主体部分当然也可以有几段,但是一定要注意换行和句子不要太长。因为这样在使用 "git log" 的时候会有缩进比较好看。 + +提交的标题行描述应该尽量的清晰和尽量的一句话概括。这样就方便相关的 Git 日志查看工具显示和其他人的阅读。 + ### 推送改动到远程仓库 - 如果你还没有克隆现有仓库,并欲将你的仓库连接到某个远程服务器,你可以使用如下命令添加:·`git remote add origin ` ,比如我们要让本地的一个仓库和 Github 上创建的一个仓库关联可以这样`git remote add origin https://github.com/Snailclimb/test.git` @@ -257,3 +269,4 @@ git push origin - [猴子都能懂得Git入门](https://backlog.com/git-tutorial/cn/intro/intro1_1.html) - https://git-scm.com/book/en/v2 - [Generating a new SSH key and adding it to the ssh-agent](https://help.github.com/en/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) +- [一个好的 Git 提交消息,出自 Linus 之手](https://github.com/torvalds/subsurface-for-dirk/blob/a48494d2fbed58c751e9b7e8fbff88582f9b2d02/README#L88)