Conversation
…tions Codify the maintainer's style policy for agents: code follows Clean Code and carries as few comments as possible (code is its own documentation - comment only what code cannot express); project writing complies with ASD-STE100 Simplified Technical English. Signed-off-by: Jonathan Springer <jps@s390x.com>
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.
Related Issue
Style policy set directly by the maintainer (process/docs change, no bug or feature).
Summary
Adds two sets of conventions to
AGENTS.md:Code conventions (new first bullets):
Writing conventions (new section):
Existing conventions (import grouping, logging) unchanged.
Note: this PR and #10 touch different sections of
AGENTS.md; either merge order works without conflict.Reviewability
triageType of Change
Verification
pytestruff check .mypy src/Manual: reviewed rendered diff; section structure and bullet style match the existing document.
Checklist
pytestpasses (N/A docs-only)ruff check .andmypy src/are green (N/A docs-only)git commit -s, DCO)