comment-quality SKILL.md skillA
comment-quality from rikvanriel/code-hygiene is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add rikvanriel/code-hygiene/comment-quality@v1.0.2Pins v1.0.2 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- rikvanriel/code-hygiene
- Path
skills/comment-quality/SKILL.md- Versions recorded
- 5
- Latest version
- v1.0.2, committed Oct 14, 2026
- First version recorded
- Sep 17, 2026
- Size
- 5,323 bytes
- Repository stars
- 2
- License
- MIT
Use when writing or reviewing comments and docstrings — new, stale, or lacking WHY.
Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.
What the file says
# Comment Quality <!-- GC-20 --> Comments explain WHY code does this, not WHAT the next line does. ## Rules ### GC-20 — WHY not WHAT, density - "/* increment counter */" → delete (code says WHAT, comment must say WHY). - Multi-paragraph essay / numbered plan comment → compress to 2-8 line WHY block. Link to issue/pr for long history, not in comment. - Doc scaffolding `/** @param` on private/internal helper → downgrade to plain `/*` WHY block or delete. Reserve full doc for exported public APIs. Grep for `name - summary` + `@param:` to catch — scaffolding appears under both markers. - 50-word para cap aim (see changelog GC-12) applies to comments too. ### GC-21 — Placement, one source of truth at definition - Doc comment lives at definition, not prototype/header when they differ. Header can have brief one-liner or none — deep WHY at def. - Helper inserted? Doc left describing wrong function after insert still compiles — read for it. ### GC-22 — Subtle logic MUST have WHY Genuinely subtle logic with no WHY comment is a bug. Check: - Locking / ordering / lifetime / invariant / barriering / ownership transfer. - Security / validation decision: why safe here but not elsewhere. …
Read the whole file at its exact version.
How to install
mdr add rikvanriel/code-hygiene/comment-quality@sha256:689d47a3f3764d71The line at the top of this page pins the label v1.0.2, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.
[](https://markdownregistry.com/a/art_bvj5yh4ltvdvsubu)
2 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 5 versions of this file, between Sep 17, 2026 and Oct 14, 2026, about one every 7 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| v1.0.2 latest | 2026-10-14 | a562258 | 5,323 B | A | view · diff |
| v1.0.1 | 2026-09-28 | 63fe6c4 | 5,315 B | A | view · diff |
| v1.0.1 | 2026-09-23 | 61abc9e | 4,230 B | A | view · diff |
| v1.0.1 | 2026-09-17 | f466313 | 4,101 B | A | view · diff |
| v1.0.1 | 2026-09-17 | e98d97b | 4,105 B | A | view |
Audit of the latest version
- pass: Frontmatter block present
- pass: Frontmatter declares a name
- pass: Frontmatter declares a description
- pass: Size between 200 bytes and 200 KB (5323 bytes)
- pass: No zero-width or bidi control characters
- pass: No instruction hidden inside an HTML comment
- pass: No link to an exfiltration or paste host
- pass: No credential-shaped string
- pass: No instruction to send local credentials anywhere
- pass: No text hidden with inline styles
- pass: No prompt-injection phrasing
- pass: No curl or wget piped into a shell
- pass: No recursive delete of root, home or parent
- pass: No instruction to read or print local credentials
- pass: No base64 blob over 200 characters
- pass: No link to a raw IP address
- pass: No script tag
Source
rikvanriel/code-hygiene · 2 stars · license MIT · pushed 2026-10-16 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_bvj5yh4ltvdvsubu GET https://markdownregistry.com/api/v1/resolve?ref=rikvanriel/code-hygiene/comment-quality GET https://markdownregistry.com/api/v1/blob/689d47a3f3764d71b99e6724c45f7fab93348f64a31de75d8a5dc17525a9a437
Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.
Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.
More from rikvanriel/code-hygiene
Every file in rikvanriel/code-hygiene