From: Sean Whitton <spwhitton@spwhitton.name>
Date: Tue, 27 Aug 2024 04:22:01 +0000 (+0800)
Subject: Discuss commit log messages on feature branches
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=c1f24bf33f1b3f067df74af471fbd891bf5c1341;p=emacs.git

Discuss commit log messages on feature branches

* admin/notes/git-workflow (Long-lived feature branches): New
section, discussing commit log messages on feature branches.

(cherry picked from commit afee71273b7041377148fbcfb554db5b45bcb3c9)
---

diff --git a/admin/notes/git-workflow b/admin/notes/git-workflow
index d33f49a1aca..d873cac4269 100644
--- a/admin/notes/git-workflow
+++ b/admin/notes/git-workflow
@@ -138,6 +138,20 @@ When everything's done, look hard at the resulting merge.  Skipping
 commits requires separate merges, so don't be surprised to see more
 than one merge commit.  If you're happy, push.
 
+
+Long-lived feature branches
+===========================
+
+The conventions for formatting commit log messages set out in CONTRIBUTE
+don't apply to commits made to feature branches.
+Thus, feel free to commit little and often, with short and simple commit
+messages.  This practice can ease development by making 'git bisect' and
+'git revert' more effective.
+
+The commit merging the feature branch to master, on the other hand,
+should follow the usual commit log message conventions.
+
+
 Warnings about X11 forwarding
 =============================