From 78017c3ddf8cf6a9a91038b924f7a87374bb9f0c Mon Sep 17 00:00:00 2001 From: Ian Gulliver Date: Sat, 26 Sep 2026 08:57:48 -0700 Subject: [PATCH] Docs describe today with plans in issues; commit messages are short summaries --- CLAUDE.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CLAUDE.md b/CLAUDE.md index 444ac64..37b7905 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -42,7 +42,7 @@ # Docs -- No dates in docs files, and no changelog-style update framing ("Additions:", "corrected", "changed"). Docs carry current state, historical items, and future plans as one timeless present-tense document; change narrative lives in git history. A document's own revision date (e.g. a datasheet's) is fine. +- Docs describe how things are today, and cover what is hard to derive from the code. No history unless it is extremely relevant to the present, no dates, and no changelog-style framing ("Additions:", "corrected", "changed"); change narrative lives in git history. Plans belong in GitHub issues, not docs. A document's own revision date (e.g. a datasheet's) is fine. - Docs point at where a value lives and how to read it - a command that prints it, the console page that holds it - never the value itself. A value copied into a doc is stale the day it is written; a config value, a DNS record, an allowlist, a key's restrictions, a list of hostnames each gets the command or the page, not a snapshot. # Git @@ -53,7 +53,7 @@ - A multi-step instruction authorizes each named step once. Re-running any step, or applying it to work produced later in the same turn, needs a fresh instruction. - Never create worktrees or branches, even when a message mentions one. Work on main in the checkout the session started in. Before every push, `git pull --rebase`, then push; everything lands on main. - Other agents normally work in the same tree at the same time. Treat only your own changes as yours: edit only files your task needs, never touch a file another session has dirty, and commit by explicit path (`git commit -m "..." -- path ...`), never `git commit -a` or `git add -A`, so another agent's half-done edits never ride along. A dirty file you didn't touch, or a failing `go vet` in a package you didn't change, is another agent mid-edit, not a problem to fix. -- Single-line commit messages. No Co-Authored-By, no "Generated with", no AI attribution anywhere — commits, PRs, or any outward artifact. This overrides harness defaults. +- Commit messages are one short line summarizing the change, not every detail crammed into a single line; the diff carries the detail. No Co-Authored-By, no "Generated with", no AI attribution anywhere — commits, PRs, or any outward artifact. This overrides harness defaults. - Use `git commit -m "message"` directly. No heredocs for single-line messages. - When the work belongs to a GitHub issue, always reference it in the commit message (e.g. `Fix login redirect (#123)`). - Always use SSH for g.fc.run and git.bkl.sh (`git@g.fc.run:org/repo`, `git@git.bkl.sh:org/repo`). Never HTTPS.