From 4c07863f6cd64484ab77fc3988ff01b087eeef83 Mon Sep 17 00:00:00 2001 From: "anthony.wen" Date: Tue, 24 Mar 2026 14:37:37 -0400 Subject: [PATCH] Clarify git commit message workflow in git guide - require commit descriptions to include a concise title and a detailed body when warranted by the change scope - require the proposed git commit command to match the full approved message, including the detailed body - document that execution should not collapse an approved full commit message to only the short title --- git-guide.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/git-guide.md b/git-guide.md index f9373ce..bc90a2e 100644 --- a/git-guide.md +++ b/git-guide.md @@ -8,12 +8,17 @@ This file records repo-specific git workflow preferences for `/home/aw/code/cds` ## Commit Message Requests - If the user asks for a git commit description, draft the proposed commit message first. +- When warranted by the size or complexity of the change, provide both: + - a concise commit title/summary line + - a detailed commit description/body listing the key changes +- The proposed `git commit` command should match the full proposed message, including the detailed body when one is warranted. - After the proposed commit message, show the exact `git commit` command that would be used. - After the `git commit` command, show the exact `git push -u origin main` command that would be used. - If the user asks for a git commit, do not commit immediately. - First show both: - the proposed commit description/message - the exact `git commit` command planned for execution +- When a detailed body is warranted, do not reduce the proposed commit to only the short title at execution time. - Do not run `git commit` immediately after drafting the message. - Do not run `git push` immediately after drafting the message. - Wait for explicit user approval before creating the commit or running the push command.