源:http://git-scm.com/book/zh/%E5%88%86%E5%B8%83%E5%BC%8F-Git-%E4%B8%BA%E9%A1%B9%E7%9B%AE%E4%BD%9C%E8%B4%A1%E7%8C%AE
评: 细节决定成败
需要谨记的是提交说明的撰写。写得好可以让大家协作起来更轻松。一般来说,提交说明最好限制在一行以内,50 个字符以下,简明扼要地描述更新内容,空开一行后,再展开详细注解。Git 项目本身需要开发者撰写详尽注解,包括本次修订的因由,以及前后不同实现之间的比较,我们也该借鉴这种做法。另外,提交说明应该用祈使现在式语态,比如,不要说成 “I added tests for” 或 “Adding tests for” 而应该用 “Add tests for”。 下面是来自 tpope.net 的 Tim Pope 原创的提交说明格式模版,供参考:
本次更新的简要描述(50 个字符以内)
如果必要,此处展开详尽阐述。段落宽度限定在 72 个字符以内。
某些情况下,第一行的简要描述将用作邮件标题,其余部分作为邮件正文。
其间的空行是必要的,以区分两者(当然没有正文另当别论)。
如果并在一起,rebase 这样的工具就可能会迷惑。
另起空行后,再进一步补充其他说明。
- 可以使用这样的条目列举式。
- 一般以单个空格紧跟短划线或者星号作为每项条目的起始符。每个条目间用一空行隔开。
不过这里按自己项目的约定,可以略作变化。
如果你的提交说明都用这样的格式来书写,好多事情就可以变得十分简单。Git 项目本身就是这样要求的,我强烈建议你到 Git 项目仓库下运行 git log --no-merges 看看,所有提交历史的说明是怎样撰写的。(译注:如果现在还没有克隆 git 项目源代码,是时候 git clone git://git.kernel.org/pub/scm/git/git.git 了。)
提交指南 git 如何提议 提交说明的撰写 Documentation/SubmittingPatches
原创
©著作权归作者所有:来自51CTO博客作者mb6440a93307547的原创作品,请联系作者获取转载授权,否则将追究法律责任
上一篇:tar 解压缩命令
下一篇:Linux xargs命令
提问和评论都可以,用心的回复会被更多人看到
评论
发布评论
相关文章
-
git提交错了?别慌,直接删除提交记录
git提交错了?别慌,直接删除提交记录
git 远程仓库 推送 -
git撤回本地commit,切换分支再提交
git回退commit
git 暂存区 工作区 -
git 如何删除某个提交之后的所有提交内容
开发过程中,有时候需要将某个提交之后的所有提交都删除,不再需要这些内容了。
git github 开发过程