doc-comments skillA
doc-comments is agent-read markdown (skill) from modem-dev/ossrules: Use this skill whenever writing or editing Rust `//`, `///`, or `//!` comments in Biome, including comments added incidentally and end-user rustdoc inside lint/assist declarations. For lint/assist rustdoc, also load lint-rule-development for content requirements. Do not use for formatter handling of comments in user code..
Indexed from public GitHub and served as immutable, content-addressed versions. Install it pinned to an exact SHA-256 with the mdr CLI, and every file is verified against the hash recorded here before it reaches your agent. The deterministic audit below grades the latest version, and the same file always earns the same grade.
What the file says
## Purpose Developer-facing comments and doc comments in this repository are read by contributors, months or years after they were written, with none of the context you have right now. This skill defines who that reader is, what each kind of comment is for, and which patterns are banned. **Scope boundary:** rustdoc inside `declare_lint_rule!` / `declare_assist_rule!` blocks is end-user documentation generated into the website. Load this skill for comment hygiene, but use [lint-rule-development](../lint-rule-development/SKILL.md) for the audience, content structure, examples, and option documentation. Its content rules take precedence for those blocks. ## The Reader For developer-facing comments, write for a Biome contributor who is competent in Rust but has **no access to your current context**: not this conversation, not the pull request, not the issue, not the diff. They see only the repository at HEAD. Two consequences follow directly: 1. **Never narrate change history.** Words like "now", "previously", "no longer", "the new approach" are meaningless at HEAD, where only one approach exists. State how the code works, not how it came to be. …
Read the whole file at its exact version.
How to install
mdr add modem-dev/ossrules/doc-comments@git:20260917.a2709ecmdr add modem-dev/ossrules/doc-comments@sha256:0518d3f099c259f4Pin to a label to follow the author's releases, or to a sha256 to freeze the exact bytes forever. Either way the resolved hash is written to mdr.lock, and mdr install reproduces it on any machine.
[](https://markdownregistry.com/a/art_m5sxobqcilui7b57)
1 badge views in 30 days
Versions
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 (8927 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
modem-dev/ossrules · 52 stars · license MIT · pushed 2026-09-21 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_m5sxobqcilui7b57 GET https://markdownregistry.com/api/v1/resolve?ref=modem-dev/ossrules/doc-comments GET https://markdownregistry.com/api/v1/blob/0518d3f099c259f437508140d3d378309bada72273993b49928a92af80af40b3
Your agent 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.