summaryrefslogtreecommitdiff
path: root/AGENTS.md
diff options
context:
space:
mode:
authorSzymon Szukalski <szymon@szymonszukalski.com>2026-04-01 15:47:45 +1100
committerSzymon Szukalski <szymon@szymonszukalski.com>2026-04-01 15:47:45 +1100
commitd14177e3e58bb24b17909db861e43528ec9be132 (patch)
tree543443baa3a2555de20b2745a231c58b36cb745c /AGENTS.md
parent08bfb73d73d0b0d63a93a341704d16ef8e3d6cab (diff)
Add git workflow guidance to AGENTS
Diffstat (limited to 'AGENTS.md')
-rw-r--r--AGENTS.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/AGENTS.md b/AGENTS.md
index f41e7d5..8cc5ea1 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -32,6 +32,16 @@ This repository is for the creation and maintenance of Emacs 30 configuration fi
- Keep regression checks aligned with the generated startup path rather than any retired hand-maintained module layout.
- For changes that affect terminal Emacs behavior, verify in an actual `emacs -nw` session as well as batch mode; batch load alone will not catch interactive tty regressions.
+## Git Workflow Expectations
+
+- Use a git-based workflow for repository changes.
+- Assume changes will be committed incrementally as the work progresses.
+- Keep changes small and focused so they can be reviewed and committed independently.
+- Treat verification as the gate for each commit-sized unit of work.
+- After verification passes for a unit of work, summarize the result and prompt the user before creating the commit.
+- Keep commit messages concise and specific to the verified change.
+- Do not bundle unrelated changes into the same commit.
+
## Documentation Expectations
- Document non-obvious conventions close to the relevant configuration in `config.org`.