Skip to content

Add agent instructions and writing rules - #983

Open
xylar wants to merge 1 commit into
MPAS-Dev:mainfrom
xylar:add-agent-writing-rules
Open

Add agent instructions and writing rules#983
xylar wants to merge 1 commit into
MPAS-Dev:mainfrom
xylar:add-agent-writing-rules

Conversation

@xylar

@xylar xylar commented Sep 9, 2026

Copy link
Copy Markdown
Collaborator

This PR adds AGENTS.md, a CLAUDE.md that 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.md covers the parts of the repo an agent gets wrong without being told: that pixi-env/ is the development environment and that creating it is a developer action, that deploy.py and deploy/cli_spec.json are contracts shared with mache and must be changed there first, that documentation is reStructuredText needing pages in both guides plus an api.rst entry, and that the machines table in the Developer's Guide has to stay consistent with compass/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 much examples 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

  • Document (in a comment titled Testing in this PR) any testing that was used to verify the changes

🤖 Generated with Claude Code

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>
@xylar

xylar commented Sep 9, 2026

Copy link
Copy Markdown
Collaborator Author

Testing

I ran pre-commit on the seven added files via pixi exec pre-commit, since no pixi-env/ exists in this worktree. trailing-whitespace and end-of-file-fixer passed; isort and flake8 were skipped because nothing here is Python.

The calibration numbers in each skill were measured from the GitHub API over MPAS-Dev/compass pull requests, reviews and comments created in 2023 and 2024, excluding bots. The design-document numbers come from the two files in docs/design_docs/. Every quoted example is linked to the PR it came from.


Posted by Claude Code on @xylar's behalf. The testing, analysis and wording above are AI-authored; please check them accordingly.

@xylar xylar self-assigned this Sep 9, 2026
@xylar xylar added the AI label Sep 9, 2026
@xylar

xylar commented Sep 9, 2026

Copy link
Copy Markdown
Collaborator Author

@matthewhoffman and @trhille, an attempt to keep Claude and Codex from spewing walls of text.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant