writing-comments SKILL.md skillA
writing-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/writing-comments@git:20260914.a750666Pins git:20260914.a750666 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/astro/.agents/skills/writing-comments/SKILL.md- Versions recorded
- 1
- Latest version
- git:20260914.a750666, committed Sep 14, 2026
- Size
- 8,981 bytes
- Repository stars
- 65
- License
- MIT
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.
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
# 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@sha256:b119966aa155d020The line at the top of this page pins the label git:20260914.a750666, 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_iel2jkado4outcal)
2 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 1 version of this file, committed on Sep 14, 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 (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 · 65 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 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.