Add agent instructions for writing for human readers - #37
Merged
Merged
Conversation
Member
Author
|
@hgoelzer, I'm attempting to teach Claude to write better for humans. I'm happy for you to make changes. But I'll merge this PR as it is for now and we can make future PRs to revise. |
PR ismip#30 rewrote the user docs for human readers but recorded the principle nowhere an agent would find it. CLAUDE.md now carries the rules for GitHub prose and for writing for human readers, in the form polaris uses, and .claude/skills/ holds the per-artifact rules and worked examples: pull request descriptions, review comments, Testing comments, plans, and the modeler-facing documentation and messages. The examples are taken from this repository's own history where a colleague wrote one; the calibration numbers are borrowed from polaris where there are too few here to measure. .claude/worktrees/ is ignored so that .claude/skills/ can be tracked. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
xylar
force-pushed
the
agent-instructions
branch
from
September 22, 2026 10:14
0b8236e to
991095d
Compare
Member
Sounds good. Step by step. |
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
2 participants
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.
PR #30 rewrote the user docs for human readers but left nothing telling an agent to keep writing that way. This adds
CLAUDE.mdand five skills under.claude/skills/(pull request descriptions, review comments, Testing comments, plans, and the modeler-facing docs and messages). They follow the pattern of theAGENTS.mdand skills in polaris, the E3SM testing framework, but are limited to the rules about writing. The rules are the same as polaris's; the examples are this repository's own where a colleague wrote one, and the length calibration borrows polaris's numbers where there are too few here to measure..claude/worktrees/is ignored so the skills directory can be tracked.Posted by Claude Code on @xylar's behalf. The testing, analysis and wording
above are AI-authored; please check them accordingly.
🤖 Generated with Claude Code