doc-comments SKILL.md skillA
doc-comments from modem-dev/ossrules is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add modem-dev/ossrules/doc-comments@git:20260917.a2709ecPins git:20260917.a2709ec in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- modem-dev/ossrules
- Path
public/files/biomejs/.claude/skills/doc-comments/SKILL.md- Versions recorded
- 1
- Latest version
- git:20260917.a2709ec, committed Sep 17, 2026
- Size
- 8,927 bytes
- Repository stars
- 65
- License
- MIT
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.
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
## 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@sha256:0518d3f099c259f4The line at the top of this page pins the label git:20260917.a2709ec, 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_m5sxobqcilui7b57)
2 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 1 version of this file, committed on Sep 17, 2026.
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 · 65 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 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.