diff --git a/AGENTS.md b/AGENTS.md index 893c92d14..7cce370e2 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -82,9 +82,10 @@ force the recompile you want. --align-pointer=name` and on `*.cpp`/`*.hpp` (same, minus `--pad-oper`). Don't hand-format C/C++ differently from what `astyle` produces. - Don't reformat existing code outside of your changes, only format your own code. -- If your change adds/changes a client command, run `make commands` to - regenerate `doc/commands.md` and `doc/commands.json` — don't hand-edit - those generated files. +- Don't touch `doc/commands.md` or `doc/commands.json`, even if your change + adds/changes a client command. Don't hand-edit them and don't commit a + `make commands` / `make style` regeneration; maintainers run `make style` + (which regenerates them) when needed. - **Keep comments short and direct.** This codebase comments in brief fragments, usually one line. Match the surrounding file. No walls of text. A comment earns its place by saying something the code cannot e.g. a return contract, where a @@ -135,7 +136,7 @@ Structure the PR description in these sections: (ProxSpace/WSL), and macOS (if applicable) — state which were tested - [ ] Existing comments in touched files preserved - [ ] New comments short and direct, no restated code or PR prose -- [ ] `doc/commands.md` / `doc/commands.json` regenerated if commands changed +- [ ] `doc/commands.md` / `doc/commands.json` left untouched ## Commit attribution @@ -157,3 +158,5 @@ Don't omit this to make a PR look purely human-written. - Don't submit ARM-side changes only test-built for one platform target. - Don't `rm -rf` any `obj/` directory to force a rebuild — it deletes tracked `.dummy` files and breaks the build until they are restored. Use `make clean`. +- Don't include changes to `doc/commands.md` / `doc/commands.json` — they are + regenerated by maintainers via `make style`.