From 99a6eb826380e4f387440a350367589a23f8452f Mon Sep 17 00:00:00 2001 From: Szymon Szukalski Date: Wed, 1 Apr 2026 16:09:05 +1100 Subject: Update README and doc review workflow --- AGENTS.md | 1 + 1 file changed, 1 insertion(+) (limited to 'AGENTS.md') diff --git a/AGENTS.md b/AGENTS.md index 8cc5ea1..07547f5 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -47,5 +47,6 @@ This repository is for the creation and maintenance of Emacs 30 configuration fi - Document non-obvious conventions close to the relevant configuration in `config.org`. - Update `README.md` whenever configuration or workflow changes alter package usage, startup behavior, keybindings, directory layout, capture flow, or other documented behavior. - `README.md` must describe the current configuration truthfully. Do not leave stale documentation behind and do not document planned behavior as current behavior. +- Before claiming a change is complete or asking to commit it, review whether `README.md` needs an update; if it does not, say so explicitly in the summary. - Update AGENTS.md when the repo workflow, Org layout, or verification expectations materially change. - Keep AGENTS.md concise and update it only when the repository structure or working rules actually change. \ No newline at end of file -- cgit v1.2.3