biome: Skill for Claude Code

.agents/skills/doc-comments/SKILL.md

doc-comments is a skill for Claude Code, Codex from biomejs/biome. It costs 78 tokens per session (2,502 once invoked), scanned A, original, Apache-2.0.

Guidance for writing Rust comments and documentation comments in the Biome codebase. It explains how to write comments that remain useful to contributors who may read them much later without the original discussion.

In plain words
What is it for?
Use it when adding or editing Rust comments, Rustdoc, or documentation for Biome lint and assist rules.
Why use it?
It prevents comments from depending on missing history or addressing a reviewer instead of explaining the code. It also covers user-facing Rust documentation inside lint and assist rules.

Skill for Claude CodeCodex

Written for no agent in particular: nothing here depends on one. Also seen: installed under .agents/ (shared by several agents).

This is biomejs/biome's own configuration. It tells Claude Code and Codex how to work on biome itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything biome configures →

About the project

Biome is a web-development toolchain that formats and checks source code for languages such as JavaScript, TypeScript, JSX, and CSS. Developers use its command-line and language-server interfaces to maintain code quality in web projects. Catalogue add-ons extend workflows around the toolchain.

biomejs/biome · 26,016 stars · on GitHub · biomejs.dev

Reuse

Borrowing it

Nothing to install: this file belongs to biomejs/biome. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/biomejs/biome/main/.agents/skills/doc-comments/SKILL.md
Clone the repo
git clone --depth 1 https://github.com/biomejs/biome

Made for: Claude Code, Codex.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for doc-comments

README.md
[![agentmods](https://agentmods.dev/badge/skills/biomejs/biome/doc-comments/github.svg)](https://agentmods.dev/skills/biomejs/biome/doc-comments)
Your own site
<a href="https://agentmods.dev/skills/biomejs/biome/doc-comments"><img src="https://agentmods.dev/badge/skills/biomejs/biome/doc-comments/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for doc-comments

Your own site · 80×15
<a href="https://agentmods.dev/skills/biomejs/biome/doc-comments"><img src="https://agentmods.dev/badge/skills/biomejs/biome/doc-comments.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 78 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 2,502 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe. Third-party audits
  • Snyk pass 7 Sept 2026
  • NVIDIA SkillSpector pass 7 Sept 2026
How audits are shown
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00078 $0.02502
Opus 5.5 $0.00031 $0.01001
Sonnet 5.5 $0.00016 $0.00500
Haiku 4.5 $0.00008 $0.00250

Measured 25d ago against content hash 4153c6cf8bca, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

doc-comments scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 25d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.agents/skills/doc-comments/SKILL.md · 248 lines

How it starts

The opening of the file, as written. The whole thing — 248 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Purpose

Rust syntax does not determine a comment's audience. Some comments explain the implementation to Biome contributors. Others are published for Biome users or client authors. Before editing a comment, trace where it is consumed by checking nearby derives, attributes, macros, generators, generated artifacts, and help snapshots.

Identify the Audience

Source context Reader and destination
Ordinary implementation //, internal item rustdoc, and most module docs Biome contributors reading the Rust source or rustdoc
Rustdoc on configuration types that derive JsonSchema, including their fields Biome users reading configuration descriptions from the JSON Schema
Rustdoc consumed by Bpaf, including command variants, arguments, and configuration fields Biome users reading CLI help
Daemon-facing Workspace methods and their serialized request and response types Authors of daemon clients and users of generated backend bindings
Rustdoc inside declare_lint_rule! or the assist macro declare_source_rule! Biome users reading rule or assist documentation on the website

A file can mix audiences. For example, workspace.rs contains contributor-facing module docs and user-facing daemon contracts, while FormatterConfiguration has user-facing field docs and contributor-facing methods.

A comment can also feed multiple destinations. Write for the least specialized reader, use only formatting supported by every destination, and inspect the rendered output. Neither /// nor pub proves who the reader is; follow the text to its destination.

Contributor reader

Write for a contributor who knows Rust but has no access to this conversation, the pull request, the issue, or the diff. Describe the code at HEAD. Never narrate change history or address a reviewer.

End-user reader

Write for an intelligent adult who may be using Biome or the documented feature for the first time. Do not require knowledge of Rust, Biome internals, advanced knowledge of the target language's idioms or terminology, or unstated ecosystem concepts.

Read the full file on GitHub · 248 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 25d ago Changed · +39 lines · +8 tokens per session 4153c6cf8bca
  2. 1mo ago First seen · 209 lines · 70 tokens per session scan A 0518d3f099c2

Subscribe to this mod's changes

doc-comments is a skill published in the GitHub repository biomejs/biome (26,016 stars, last pushed today), licensed Apache-2.0. It adds 78 tokens to every session and 2,502 once invoked, about $0.0003 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.