- 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
2.5 KiB
2.5 KiB
Git Guide
This file records repo-specific git workflow preferences for /home/aw/code/cds.
Repository Reference
- Active repository:
https://git.devreser.com/anthony.wen/cds-ai.git - Treat this repository URL as the current
originfor this workspace unless the user explicitly says it changed.
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 commitcommand should match the full proposed message, including the detailed body when one is warranted. - After the proposed commit message, show the exact
git commitcommand that would be used. - After the
git commitcommand, show the exactgit push -u origin maincommand 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 commitcommand 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 commitimmediately after drafting the message. - Do not run
git pushimmediately after drafting the message. - Wait for explicit user approval before creating the commit or running the push command.
- Do not treat a request such as "give me the git commit" or "make the commit" as approval by itself.
- Only execute
git commitafter the user explicitly approves the displayed commit command. - If the user changes the requested commit message or scope after commands are shown, rebuild the proposal and wait for fresh approval.
Push Requests
- When the user asks to push, use
git push -u origin mainby default unless the user explicitly asks for a different remote or branch. - Do not execute
git push -u origin mainor any other git push command from the assistant when credentials or an SSH key passphrase might be required. - Instead, show the exact push command and tell the user to run it directly in the terminal.
- Do not accept passwords or passphrases through chat for git operations.
- If the user asks the assistant to take the password/passphrase handoff, refuse and direct the user to complete the prompt from the terminal.
Commit Scope
- When committing, include only the files relevant to the approved change.
- Leave unrelated worktree changes uncommitted unless the user explicitly asks to include them.