Loading skill
Install any skill in seconds. Free to start, no credit card required.
Get Started Free →withastro/writing-comments
How to write JSDoc (/** */) and inline (//) comments in the Astro codebase, for contributors reading the source — not end users.
Passed 19 of 23 test cases with the skill, and 13 of 23 without it.
and 5 more in the full report
7 fixed12 passed either way3 still failing1 broke
Tokens, turns and time describe resource use, not a dollar price.
One of 7 test cases the skill fixed. Same model, same prompt, with and without the skill.
Write an inline comment for the line 'activeConnections.delete(connectionId);' in Astro's dev server manager.
| Checked | Without skill | With skill |
|---|---|---|
| The response advises against writing a comment that merely restates the code statement. | Missed | Passed |
The instructions your model reads when the skill loads.
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.
This skill governs contributor-facing comments in the TypeScript/JavaScript source. It does not apply to end-user documentation:
@docs in
packages/astro/src/types/public/config.ts
and
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
for those, and get docs-team review — CI regenerates the reference when
types/public/** changes.types/public/** is surfaced to users through editor
IntelliSense. Write it for Astro users building a site, not for
contributors reading the source.Everything below is about the source a contributor reads at HEAD.
Write for an Astro contributor who is competent in TypeScript 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:
@deprecatedtest cases passed, vs 13 / 23 without
More skills from the same source and nearby in the registry, with their headline benchmark lift.