unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
* Re: ChangeLog and commit messages
@ 2023-06-18 14:03 Bruno Haible
  0 siblings, 0 replies; 23+ messages in thread
From: Bruno Haible @ 2023-06-18 14:03 UTC (permalink / raw)
  To: Po Lu; +Cc: emacs-devel

Po Lu wrote:
> I find myself often frustrated that Git requires a commit title.  In
> such a title, committers are expected to summarize in detail changes to
> dozens of different functions in less than 74 characters of text.

That's a feature, not a bug.

The commit title has benefits for the co-developers and for yourself, the
committer. Namely:

* If I am a co-developer, I want to know
  - the purpose of the change,
  - whether I can expect my existing tests or usage to continue working, or
    whether it will break,
  - whether I have the opportunity to extend my tests / change my usage.

For you, the committer, simply think of someone else asking you "what is
the point of this change?".

Thinking about this title for 30 seconds gives you the opportunity to
  - detect when you are about to commit two unrelated things (e.g. a bug fix
    and a new feature)
  - if it's a new feature: question yourself whether you have been including
    necessary documentation changes and/or a NEWS entry.

Bruno






^ permalink raw reply	[flat|nested] 23+ messages in thread

end of thread, other threads:[~2024-08-27  4:23 UTC | newest]

Thread overview: 23+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
     [not found] <87a5wxb5sl.fsf.ref@yahoo.com>
2023-06-18  7:14 ` ChangeLog and commit messages Po Lu
2023-06-18  7:39   ` Eli Zaretskii
2023-06-18  7:41     ` Po Lu
2023-06-18  8:02       ` Eli Zaretskii
2023-06-18 14:50       ` Konstantin Kharlamov
2023-06-19  0:48         ` Po Lu
2023-06-19  6:25           ` Konstantin Kharlamov
2023-06-19  6:51             ` Po Lu
2023-06-19  9:07               ` Konstantin Kharlamov
2023-06-19 10:10                 ` Po Lu
2023-06-19 11:57                   ` Dmitry Gutov
2023-06-19 16:59                     ` Eli Zaretskii
2023-06-19 17:24                       ` Dmitry Gutov
2023-06-19 22:18                   ` Konstantin Kharlamov
2023-06-19 16:33               ` Eli Zaretskii
2023-06-20  0:55                 ` Po Lu
2023-06-23  6:50                 ` Sean Whitton
2023-06-23  7:16                   ` Eli Zaretskii
2024-08-27  4:23                     ` Sean Whitton
2023-06-18  7:44   ` Sean Whitton
2023-06-18 22:38   ` Dmitry Gutov
2023-06-19  8:52   ` Jose E. Marchesi
2023-06-18 14:03 Bruno Haible

Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).