agentleFS
MediaPluralMediaPlural/agent-proven/skills/prose-hygiene/SKILL.md

prose-hygiene

Skill1 starsChanged 13 days agoMITView on GitHub

Sweep grammar, typos, and clarity in comments and docs.

1 other project uses a version of this.

Adopted by

Most recently taken up by

  • Other versions1 project uses a version of this.

    Word for word · 0

    None found.

    Edited · 0

    None found.

    Wrote their own version · 1

    1. hex/claude-sessions★ 54same name

    How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.

  • In this repository10 other files it gives its agents.

The file

We split this skill into the rules it gives an agent

4 rules. About 0 are common, 4 are distinctive, and 0 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈4

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    After any agent-authored batch of comments/docstrings

    line 28
  2. Distinctive:

    Before committing docs, README changes, or PR descriptions

    line 29
  3. Distinctive:

    Don't use for: deleting stale/expired comments (that's stale-cleanup, a peer skill).

    line 33
  4. Distinctive:

    Completion criterion: every finding fixed or triaged.

    line 57

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Prose Hygiene

A gate battery for the words in a codebase: comments, docstrings, commit messages, PR descriptions, README and docs pages. Code quality tooling ignores prose; agents writing prose at speed accumulate grammar drift, typos, and unclear antecedents that make the next reader (human or model) mistrust the comment — or worse, follow it into the wrong behavior.

Distinct from stale-comment cleanup (see Peers: code-hygiene-skills handles expired comments; this skill handles broken prose — grammar, spelling, clarity — in comments that should stay).

When to Use

  • After any agent-authored batch of comments/docstrings
  • Before committing docs, README changes, or PR descriptions
  • Sweeping a repo's comment grammar before a public release
  • Post-review: reviewers flagging "this comment doesn't parse"

Don't use for: deleting stale/expired comments (that's stale-cleanup, a peer skill); rewriting code; changing technical content (only its expression).

The Sweep

  1. Collect — the changed files' comments, docstrings, and the commit message/PR description. (For full-repo sweeps: docs pages + comment inventory.)
  2. Check, per finding class:
    • Grammar — broken sentences, subject/verb disagreement, tense drift
    • Spelling — typos, wrong homophones (their/there, it's/its), casing of identifiers (identifiers themselves are NEVER "corrected" — see Pitfalls)
    • Clarity — ambiguous pronouns ("it updates it"), double negatives, sentences whose subject changes mid-stream
    • Consistency — mixed voice (imperative vs descriptive), mixed number agreement, Oxford-comma drift within one file's comments
  3. Fix minimally. Preserve meaning exactly; prose fixes never change what the comment claims about the code. If a comment's content is wrong, that's a code bug — file it separately, don't silently rewrite it.
  4. Verify — re-read every changed line; grammar fixes that alter meaning are regressions.

Completion criterion: every finding fixed or triaged; changed files' comments read clean; no identifier was touched.

Pitfalls

  • Never "fix" identifiers. A finding that is actually a variable name, flag, path, or quoted output is correct as-is. Check before changing — this is the #1 false-positive class.
  • Meaning-preservation is absolute. "Its not caching" → "It's not caching" is a fix; "It's not caching" → "It caches" is a content change smuggled through a grammar edit. Never.
  • Don't restyle. Fixing grammar ≠ imposing a style guide. If the file's comments are casual, fixed-casual; don't convert to formal.
  • Quoted output and literals: strings the code prints, error messages, and fixture literals are functional. Leave them unless the task includes them.

Verification

Runnable check: spell-check the changed files with the identifiers excluded (example: codespell with the repo's ignore file, or a targeted pass), and diff-review that only prose lines changed:

git diff --unified=0 -- <changed-files> | grep -E '^[+-]' | grep -v -E '^[+-]{3}'

Expected: exit 0; every +/- line pair is comment/docstring/commit-prose; zero identifier or code lines in the diff.

Evidence to capture: the prose-only diff, and the spell-check output before/after.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.