Files
element-call-Github/docs/agents/workflow.md
T
fkwpandClaude Opus 5 a58a5f615f Add AGENTS.md documenting the repo's conventions (#4256)
* Add AGENTS.md documenting the repo's conventions

Codifies what is currently tribal knowledge or only discoverable by reading CI
config: the view model / view contract, the rule that nothing reads the page,
Clean Code ordering, the three test layers, and reuse-before-you-build.

The root AGENTS.md is the always-loaded minimum and routes to docs/agents/, so
an agent loads only the detail its task needs.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

* Allow either hand at the commit, and measure continuous redraws

Committing from the agent rules out running it where there is no git
identity, a sandbox included. Either is now fine: commit on the user's
word where the setup allows it, or write the message and hand it over.

Redrawing continuously is the other addition. A level meter reported a
fresh value every animation frame, so its whole menu reconciled sixty
times a second, silence included, and nobody noticed until review. A PR
that adds anything of the kind now says what it costs, or better, counts
the redraws — commits rather than render calls, since React runs a
component it then discards.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-09-11 15:12:15 +02:00

2.9 KiB

Agent workflow

Scratch files live in agent-workspace/

Git-ignored. One kebab-case subfolder per task, matching the branch topic: agent-workspace/<slug>/.

File Purpose
plan.md The concrete approach — files, symbols, edit order — once direction is confirmed
commit-msg.txt git commit -F agent-workspace/<slug>/commit-msg.txt
pr-body.md gh pr create --body-file agent-workspace/<slug>/pr-body.md
implementation-summary.md What was built, decisions, trade-offs
NN-prompt.md Raw prompt text, numbered, when worth keeping
  • Nothing here is durable. The folder is ignored, so anything worth keeping is promoted into the PR body, a doc, or a feature spec before the task ends.
  • Never write scratch files to the repo root. Stray load_test_summary.md and config.json_ files are what this folder prevents.
  • Start pr-body.md from .github/PULL_REQUEST_TEMPLATE.md and fill every section.
  • Commit subjects are plain imperative English. No conventional-commits prefixes.
  • A plan.md and a feature spec sit at different altitudes; neither replaces the other. A spec in FEATURES_SPEC/ is durable and deliberately abstract — behaviour, decisions, acceptance criteria — so the feature can be rebuilt against a main nobody has seen yet. A plan is one slice of it landing on today's main: the paths, symbols and edit order the spec's decisions and criteria must not name. FEATURES_SPEC/AGENTS.md wins wherever the two genuinely overlap.

Hand off before the quality pass

  • Implement the change, run the narrowest check that rules out an obviously broken handoff, then stop and ask whether the direction is right.
  • Full pnpm lint, the whole suite, coverage and benchmarks come after the direction is confirmed.
  • Wider refactors, extra tests and documentation polish are follow-up work, not part of the first handoff.
  • If a check is needed before feedback, keep it to the touched code and say why.

Commit and PR readiness

  • Commit once the user confirms direction, or asks for one. Not before. Where the setup has no git identity, a sandbox included, write the message to commit-msg.txt and hand it over instead.
  • Ready means every gate in AGENTS.md is green and the change is covered at the layers testing.md asks for. Read the diff against code-style.md first.
  • Re-run the whole checklist after any fix. Only on green, either way.
  • Once a human has started reviewing, fix forward — never force-push a regeneration over a review in progress.