Every premium and members-only resource for $9.99/month, as a no-commitment subscription. See the plans

PalateKit

Sign in
Menu

Request a resource

Describe the resource you are missing in one sentence. We will email you when it is published.

0 / 280

A page, a video or an image online.

Unlock PalateKit

Unlock everything

Plan

Paying means accepting our terms of sale.

Secure payment by Stripe. Receipts and invoices sent by email.

Welcome back

Sign in to install, download or save this resource. A free account is enough for free resources.

Writing JSDoc and inline code comments v1.0.0

Use this resource to write or fix JSDoc and inline comments in source code

New

  • 415 downloads
  • 163 likes
  • 178 saves

Free

Install with the CLI

In a terminal, from the folder you want:

npx --yes palatekit@latest install contributor-code-comments-style

With no option, the skill goes to ~/.agents/skills/; add --agent claude-code (or codex, cursor…) to target an agent.

First time: connect the CLI with

npx --yes palatekit@latest login

The agent applies the Astro repository's comment conventions: it describes behavior, links workarounds to the issue and drops filler phrasing. It does not handle the @docs blocks of the configuration reference, which are reserved for user documentation.

Mostly picked by

Updated November 2, 2026

Card for the “Writing JSDoc and inline code comments” skill

Details

Works in
Install guides
Generates with
Your agent's model
Licence
MIT

Similar resources

View all

What you get

  • SKILL.md: rules, banned patterns and a self-check before finishing
  • evals/evals.json: test cases for the skill

Good fit for

  • You fix a bug and need to comment a workaround
  • Your comments simply repeat the code

Not for

    Tags

    • comments
    • jsdoc
    • source code
    • conventions

    About

    You say

    “Add comments to this cache module following the repository's conventions.”

    Card for the “Writing JSDoc and inline code comments” skill

    Skill published by withastro under the MIT license, delivered in its original version.

    Show more

    How to use it

    1. Install the skill in your agent's skills folder
    2. Ask your agent to write or fix JSDoc and inline comments in source code
    3. Review and adjust the result

    Content preview

    Files

    • evals/evals.json5.4 KB
    • LICENSE3.5 KB
    • NOTICE-PALATEKIT.md0.5 KB
    • SKILL.md11 KB

    Origin and licence

    Listed unmodified

    Author
    withastro
    Source
    github.com/withastro/astro/tree/883e672fd0beb575b14776bc842bdee84433e6af/.agents/skills/writing-comments
    Licence
    MIT

    Notice

    « writing-comments » (withastro, MIT) livré dans sa version d'origine : fiche en français et en anglais par PalateKit.

    User reviews

    –

    No ratings yet

    Loading reviews…

    Delete your review?

    Your rating and comment will be removed from the page.