From afee71273b7041377148fbcfb554db5b45bcb3c9 Mon Sep 17 00:00:00 2001 From: Sean Whitton Date: Tue, 27 Aug 2024 12:22:01 +0800 Subject: [PATCH] Discuss commit log messages on feature branches * admin/notes/git-workflow (Long-lived feature branches): New section, discussing commit log messages on feature branches. --- admin/notes/git-workflow | 14 ++++++++++++++ 1 file changed, 14 insertions(+) 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 =============================