From ea1c65d4bb1aeac801d8a969715ec0a4f5b15de9 Mon Sep 17 00:00:00 2001 From: "Eric S. Raymond" Date: Sun, 26 Oct 2014 20:50:32 -0400 Subject: [PATCH] Guidance on commit-comment formats. --- admin/ChangeLog | 3 ++- admin/notes/repo | 18 ++++++++++++++++++ 2 files changed, 20 insertions(+), 1 deletion(-) diff --git a/admin/ChangeLog b/admin/ChangeLog index 84a809826a9..6bd5ceaca55 100644 --- a/admin/ChangeLog +++ b/admin/ChangeLog @@ -1,7 +1,8 @@ 2014-10-27 Eric S. Raymond * notes/bzr: Renamed to notes/repo, reorganixed to separate - VCS-dependent from VCS-independent stuff. + VCS-dependent from VCS-independent stuff. Added guidance about + commit-comment format under DVCSes. * notes/BRANCH: Merged into notes/repo. diff --git a/admin/notes/repo b/admin/notes/repo index 910b092e1ab..2044bb9ea2d 100644 --- a/admin/notes/repo +++ b/admin/notes/repo @@ -1,5 +1,23 @@ NOTES ON COMMITTING TO EMACS'S REPOSITORY -*- outline -*- +* Use DVCS commenting conventions + +Commits should follow the conventions used in all modern distributed +version-control systems. That is, they should consist of + +- A self-contained topic line no more than 75 chars long. + +- If other content follows the topic line, there should be + a blank line separating the two. + +Try to keep your commits - and your commit comments - small. If +you feel an urge to put a bullet list in your commit comment, it's +doing too many things at once. + +Yes, these directins are a departure from historical Emacs practice, +but it helps modern log-viewing and summary tools work better so that +other people can comprehend your code. + * Commit to the right branch You can view the available Emacs branches at -- 2.39.5