Add agent instructions and writing rules - #983
Open
xylar wants to merge 1 commit into
Open
Conversation
Adds AGENTS.md with repository-wide instructions for AI agents, a CLAUDE.md that points at it, and per-artifact writing skills under .claude/skills/. The writing rules exist because agent-written GitHub prose has been running an order of magnitude longer than what colleagues write. Each skill carries the rules for one artifact, calibration measured from Compass's own 2023 and 2024 history, and worked examples taken from real pull requests where they exist. Adapted from the equivalent files in Polaris. The environment, contract and human-writing sections carry over; the style, documentation and supported-machine sections follow Compass's own tooling (flake8 and isort, reStructuredText docs, the machines table in the Developer's Guide). All calibration numbers and examples were re-measured against MPAS-Dev/compass. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Collaborator
Author
TestingI ran pre-commit on the seven added files via The calibration numbers in each skill were measured from the GitHub API over Posted by Claude Code on @xylar's behalf. The testing, analysis and wording above are AI-authored; please check them accordingly. |
Collaborator
Author
|
@matthewhoffman and @trhille, an attempt to keep Claude and Codex from spewing walls of text. |
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.
This PR adds
AGENTS.md, aCLAUDE.mdthat points at it, and five writing skills under.claude/skills/, so that AI agents working in this repo follow Compass conventions instead of inventing their own.AGENTS.mdcovers the parts of the repo an agent gets wrong without being told: thatpixi-env/is the development environment and that creating it is a developer action, thatdeploy.pyanddeploy/cli_spec.jsonare contracts shared withmacheand must be changed there first, that documentation is reStructuredText needing pages in both guides plus anapi.rstentry, and that the machines table in the Developer's Guide has to stay consistent withcompass/machines/.The writing rules are the other half. Agent-written GitHub prose has been running an order of magnitude longer than what colleagues write, and length is the whole complaint. Each skill carries the rules for one artifact, calibration measured from Compass's own 2023 and 2024 history, and worked examples quoted from real pull requests. The
Too muchexamples are constructed in the style of real agent-written prose from elsewhere, and are labeled as such.These files are adapted from the equivalent ones in Polaris. The environment, contract and human-writing sections carry over. The style, documentation and supported-machine sections follow Compass's own tooling, and every calibration number and example was re-measured against
MPAS-Dev/compass.Checklist
Testingin this PR) any testing that was used to verify the changes🤖 Generated with Claude Code