docs: clarify mode descriptions and agent writing guidance - #523
Merged
Conversation
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
Invariants
None. No PUR-N rule or implementation changes.
Spec impact
Checks
make gates: incomplete as documented above.Anything else
Written mostly by Codex.