Charles Choi <kickingve...@gmail.com> writes:

> Thanks for the reply. As I anticipate a number of changes, is it
> better to have more commits for each change to explain them or to have
> a single commit?

As a rule of thumb, each commit should group as many similar changes as
the first line of the commit message can describe in a useful,
informative way, and no more.

See the instructions for Org commit messages here:
https://orgmode.org/worg/org-contribute.html#commit-messages

The instructions are oriented toward code, but provide useful guidelines
for Worg documentation as well. In particular, this rationale:

  "You should be able to tell, without looking into actual changes, what
  happened to Org mode repository recently.

  If you split similar changes into multiple commits, they will not
  provide useful information - you will just introduce consequent
  (almost) identical lines into the log.

  For the same reason, putting very different changes into a single commit
  message is not useful. There is only that much you can fit into the
  first line. If you do not describe all the changes in the first line,
  they may be missed while reading the log."

Yours,
Christian

Reply via email to