在Git中,有什么好的约定多个注释格式化为单个提交(In git, what are some go

2019-08-17 04:52发布

我不知道如何人们通常分离出多条评论,在一个单一的提交。 明星? 逗号? 单独的线路? 只是想知道你发现了什么是最好的。

现在我用这个当我通过Emacs的补充意见,但不知道我喜欢它:

Added error messaging
Cleaned up sign-up UI
Added recaptcha

# Please enter the commit message for your changes. Lines starting
# with '#' will be ignored, and an empty message aborts the commit.
#
# Committer: Conrad Chu <chuboy@conradlaptop.local>
#
# On branch master
# Changes to be committed:
#   (use "git reset HEAD <file>..." to unstage)
#
#       modified:   app/controllers/api_controller.rb
#       modified:   app/controllers/users_controller.rb
#       modified:   app/models/user.rb
#       modified:   app/views/users/new.html.erb
#       modified:   app/views/users/show.html.erb
#       modified:   config/environment.rb
#       modified:   db/migrate/20090923001219_create_users.rb
#       modified:   db/schema.rb
#       modified:   doc/README
#       modified:   public/stylesheets/master.css
#       new file:   vendor/plugins/recaptcha/.gitignore
#       new file:   vendor/plugins/recaptcha/CHANGELOG

Answer 1:

Git有关于日志消息很强的公约,但是规则很简单:

  1. 第一行是提交的摘要
  2. 第一线可以具有范围描述前缀“模块”
  3. 第二行是空的
  4. 然后接着段落的讨论,只要它需要是

作为一个开始,你应该使用这些公约,作为演示工具甚至依靠他们(第二行是空是很重要的,而且在很多情况下,你只能看到第一行摘要。)

使用Git,承诺要小,因此第一个答案是当然的,你不应该修改很多事情一个承诺。 你应该有三个提交,没有之一。

但是,你可以写在提交日志整个文章,在那里你可以描述他们在所有的细节变化(动机,废弃的设计,想法)。 如果三个转变真正属于一起,本文会清楚为什么。

我发现更多的指令描述相同GIT中提交的消息的公约,与其中的git命令取决于特定的格式的例子。 (大部分是所有基于现有的约定:通过电子邮件发送补丁。)



Answer 2:

我有@ kaizer.se同意。 使用Git的阶段性修改为3次不同的提交能力。 通过这种方式,你有每次修改就是一个明确的想法和你的提交的评论会给你为什么。 在合并到主干分支(假设你使用枝条作功能MODS)可以卷起来的这些较小提交到一个合并。



Answer 3:

我努力不要犯这需要太多的评论的变化,但如果有需要它,我通常做这样的事情:

Multiple changes:

- done this
- fixed that
- removed other

Maybe some additional explanations.

尽量保持你的提交原子,就功能而言。 I期帅哥或该行代码,当我忘记每完成功能后,实际提交。



Answer 4:

看看这里, http://progit.org/book/ch5-2.html ,有承诺的准则和样本提交。



文章来源: In git, what are some good conventions to format multiple comments to a single commit
标签: git dvcs