Skip to content

Commit 74cc6cd

Browse files
committed
ai(rules[AGENTS]) add HEREDOC pattern for multi-line git commits
why: Ensure proper formatting of why/what sections in commit messages. what: - Add example using cat <<EOF style for multi-line commits
1 parent 66872be commit 74cc6cd

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

AGENTS.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,18 @@ def test_vcspull_sync(git_repo):
169169
# git_repo is already a GitSync instance with a clean repository
170170
# Use it directly in your tests
171171
```
172+
For multi-line commits, use heredoc to preserve formatting:
173+
```bash
174+
git commit -m "$(cat <<'EOF'
175+
feat(Component[method]) add feature description
176+
177+
why: Explanation of the change.
178+
what:
179+
- First change
180+
- Second change
181+
EOF
182+
)"
183+
```
172184

173185
#### Test Structure
174186

0 commit comments

Comments
 (0)