]> git.eshelyaron.com Git - emacs.git/commitdiff
Discuss commit log messages on feature branches
authorSean Whitton <spwhitton@spwhitton.name>
Tue, 27 Aug 2024 04:22:01 +0000 (12:22 +0800)
committerEshel Yaron <me@eshelyaron.com>
Wed, 4 Sep 2024 07:51:38 +0000 (09:51 +0200)
* admin/notes/git-workflow (Long-lived feature branches): New
section, discussing commit log messages on feature branches.

(cherry picked from commit afee71273b7041377148fbcfb554db5b45bcb3c9)

admin/notes/git-workflow

index d33f49a1acadb9a691a50cf3c335b5055194006e..d873cac4269ee04d7ec59bf12a38ff27fb9a37a2 100644 (file)
@@ -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
 =============================