anthony.wen/cds-ai
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Clarify git commit message workflow in git guide

Browse Source 
- 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
This commit is contained in:
anthony.wen
2026-03-24 14:37:37 -04:00
parent fa97ce5ad0
commit 4c07863f6c
1 changed files with 5 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
git-guide.md
View File

@@ -8,12 +8,17 @@ This file records repo-specific git workflow preferences for `/home/aw/code/cds`
## Commit Message Requests ## Commit Message Requests
- If the user asks for a git commit description, draft the proposed commit message first. - 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 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. - 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. - If the user asks for a git commit, do not commit immediately.
- First show both: - First show both:
- the proposed commit description/message - the proposed commit description/message
- the exact `git commit` command planned for execution - 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 commit` immediately after drafting the message.
- Do not run `git push` 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. - Wait for explicit user approval before creating the commit or running the push command.