writing-comments skillA
writing-comments is agent-read markdown (skill) from modem-dev/ossrules: How to write JSDoc (/** */) and inline (//) comments in the Astro codebase, for contributors reading the source — not end users. Use whenever writing or editing comments in .ts/.js source, including comments added incidentally while fixing bugs or building features. Does not cover the @docs-generated config/error reference..
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
# Writing Comments ## Purpose 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 This skill governs **contributor-facing** comments in the TypeScript/JavaScript source. It does **not** apply to end-user documentation: - JSDoc blocks tagged `@docs` in [`packages/astro/src/types/public/config.ts`](../../../packages/astro/src/types/public/config.ts) and [`packages/astro/src/core/errors/errors-data.ts`](../../../packages/astro/src/core/errors/errors-data.ts) are scraped by an external `docgen` tool and published to the Astro docs website. Follow [`packages/astro/src/core/errors/README.md`](../../../packages/astro/src/core/errors/README.md) for those, and get docs-team review — CI regenerates the reference when `types/public/**` changes. - Other JSDoc across `types/public/**` is surfaced to users through editor IntelliSense. Write it for Astro **users** building a site, not for contributors reading the source. …
Read the whole file at its exact version.
How to install
mdr add modem-dev/ossrules/writing-comments@git:20260914.a750666mdr add modem-dev/ossrules/writing-comments@sha256:b119966aa155d020Pin 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_iel2jkado4outcal)
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 (8981 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_iel2jkado4outcal GET https://markdownregistry.com/api/v1/resolve?ref=modem-dev/ossrules/writing-comments GET https://markdownregistry.com/api/v1/blob/b119966aa155d020ec6fbe3b02b3e2e58f5e29ad5aed3ae83b3a0318b9165228
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.