Skip to content

docs: clarify mode descriptions and agent writing guidance - #523

Merged
MarcusKainth merged 1 commit into
mainfrom
docs/clarify-agent-guidance
Sep 8, 2026
Merged

docs: clarify mode descriptions and agent writing guidance#523
MarcusKainth merged 1 commit into
mainfrom
docs/clarify-agent-guidance

Conversation

@MarcusKainth

@MarcusKainth MarcusKainth commented Sep 8, 2026

Copy link
Copy Markdown
Owner

What this changes, and why

AGENTS.md introduces only emulation mode and ambiguously applies its comment rules to commit messages. Describe both emulation and native mode, and clarify that commits carry rationale and relevant history while comments describe the current code. CLAUDE.md links to AGENTS.md, so both tools receive the same guidance.

Evidence

$ git diff origin/main...HEAD --stat
 AGENTS.md | 11 +++++++----
 1 file changed, 7 insertions(+), 4 deletions(-)

$ git diff --check origin/main...HEAD
(no output; exit 0)

Invariants

None. No PUR-N rule or implementation changes.

Spec impact

  • None. SPEC.md, NATIVE.md and PURITY.md are unchanged.

Checks

  • make gates: incomplete as documented above.
  • No AI attribution trailers in the commits.

Anything else

Written mostly by Codex.

Describe both execution modes so the entry point covers native work. Clarify that commit messages carry rationale and relevant history while comments describe the code at hand.
@github-actions github-actions Bot added the area: docs The prose: READMEs, ADRs, and the contributor documents label Sep 8, 2026
@MarcusKainth
MarcusKainth merged commit 259346f into main Sep 8, 2026
20 checks passed
@MarcusKainth
MarcusKainth deleted the docs/clarify-agent-guidance branch September 8, 2026 15:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: docs The prose: READMEs, ADRs, and the contributor documents

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant