Diagram Design
cathrynlavery/diagram-design
Creates branded diagrams, from architecture, flowchart and sequence to charts and maps, as self-contained HTML with inline SVG, with import from draw.io, Mermaid and Excalidraw.
Full comment and docstring policy for this repo — what to delete, what to keep compressed, what to never touch, and the two local traps.
Install Code Comments
$ npx skills add overmind-core/overmind --skill code-comments -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install overmind-core/overmind code-comments --agent claude-codeProject scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).
$ git clone --depth 1 https://github.com/overmind-core/overmind.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/code-comments .claude/skills/code-comments && rm -rf skills-srcUse ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.
Claude Code skills documentation · loads skills from .claude/skills/
Install the "code-comments" agent skill from https://github.com/overmind-core/overmind/tree/main/.agents/skills/code-comments into .claude/skills/code-comments/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "code-comments", then confirm the skill loads.Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$skill-installer install https://github.com/overmind-core/overmind/tree/main/.agents/skills/code-commentsType this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.
$ npx skills add overmind-core/overmind --skill code-comments -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install overmind-core/overmind code-comments --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/overmind-core/overmind.git skills-src && mkdir -p .agents/skills && cp -r skills-src/.agents/skills/code-comments .agents/skills/code-comments && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "code-comments" agent skill from https://github.com/overmind-core/overmind/tree/main/.agents/skills/code-comments into .agents/skills/code-comments/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "code-comments", then confirm the skill loads.Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add overmind-core/overmind --skill code-comments -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install overmind-core/overmind code-comments --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/overmind-core/overmind.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/.agents/skills/code-comments .cursor/skills/code-comments && rm -rf skills-srcUse ~/.cursor/skills/ instead of .cursor/skills for a personal install.
Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/
Install the "code-comments" agent skill from https://github.com/overmind-core/overmind/tree/main/.agents/skills/code-comments into .cursor/skills/code-comments/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "code-comments", then confirm the skill loads.Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gemini skills install https://github.com/overmind-core/overmind.git --path .agents/skills/code-comments--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.
$ npx skills add overmind-core/overmind --skill code-comments -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install overmind-core/overmind code-comments --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/overmind-core/overmind.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/.agents/skills/code-comments .gemini/skills/code-comments && rm -rf skills-srcUse ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.
Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/
Install the "code-comments" agent skill from https://github.com/overmind-core/overmind/tree/main/.agents/skills/code-comments into .gemini/skills/code-comments/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "code-comments", then confirm the skill loads.Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gh skill install overmind-core/overmind code-commentsInstalls for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).
$ npx skills add overmind-core/overmind --skill code-comments -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/overmind-core/overmind.git skills-src && mkdir -p .github/skills && cp -r skills-src/.agents/skills/code-comments .github/skills/code-comments && rm -rf skills-srcUse ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.
GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/
Install the "code-comments" agent skill from https://github.com/overmind-core/overmind/tree/main/.agents/skills/code-comments into .github/skills/code-comments/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "code-comments", then confirm the skill loads.GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add overmind-core/overmind --skill code-comments -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install overmind-core/overmind code-comments --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/overmind-core/overmind.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/.agents/skills/code-comments .opencode/skills/code-comments && rm -rf skills-srcUse ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.
OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/
Install the "code-comments" agent skill from https://github.com/overmind-core/overmind/tree/main/.agents/skills/code-comments into .opencode/skills/code-comments/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "code-comments", then confirm the skill loads.OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
Facts
- Skill name
code-comments- GitHub stars
- 597
- Token cost
- ~1.1k tokens
- SKILL.md length
- 577 words
- Files
- 1
- Skills in repo
- 20
- Repo updated
- First seen
- Licence
- AGPL-3.0
At a glance
Full comment and docstring policy for this repo — what to delete, what to keep compressed, what to never touch, and the two local traps.
- Pruning comments and docstrings in any language
- SKILL.md covers Delete, Keep, compressed to one or two…, Large blocks and Python specifics, plus 3 more sections
- Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
- Tasks that involve Technical documentation
What it does
Code Comments is an agent skill from overmind-core/overmind. Full comment and docstring policy for this repo — what to delete, what to keep compressed, what to never touch, and the two local traps. Use when writing, reviewing, or pruning comments and docstrings in any language.
Its SKILL.md is about 1.1k tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.
It sits in Development, covering Technical documentation. The repository describes itself as: The platform for continuously improving AI agents. The licence is AGPL-3.0.
When your agent uses it
- Pruning comments and docstrings in any language
- Tasks that involve Technical documentation
Example prompts
- “/code-comments”
Requirements
- Python 3
What it can do on your machine
Read from SKILL.md and the folder at commit 3dec73c. It shows what the files ask for, not the result of running them.
Tool permissions
Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.
From allowed-tools in the SKILL.md frontmatter.
Runs code
No scripts in the folder and no shell commands in SKILL.md.
From the folder's file list and the shell code blocks in SKILL.md.
Network
No URLs in SKILL.md.
From URLs in SKILL.md, links to its own repository left out.
Credentials
Names no API keys, tokens, secrets or passwords.
From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.
Context cost
Code Comments loads about 1.1k tokens when it runs. Until then it costs about 58 tokens; SKILL.md has 577 words of instructions outside code blocks.
Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.
Safety
Auto-check passed
The automated check found no risky patterns in SKILL.md.
Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.
SKILL.md
The full file from overmind-core/overmind at commit 3dec73c, republished under its AGPL-3.0 licence (© overmind-core). 577 words, ~1,053 tokens.
Download SKILL.mdSave it as
.claude/skills/code-comments/SKILL.md (or your agent's skills folder).- name
- code-comments
- description
- Full comment and docstring policy for this repo — what to delete, what to keep compressed, what to never touch, and the two local traps. Use when writing, reviewing, or pruning comments and docstrings in any language.
Comments
A comment earns its place only by carrying information the code cannot. Apply this test to every comment you write or read:
If I delete this, does a competent engineer lose something they cannot readily infer from the code?
If no, delete it. Prefer fixing the name or the structure over explaining it.
Delete
- Restatements of the next line or block.
- The purpose of a clearly named variable, function, component, prop or state.
- Straightforward control flow ("loop over rows", "bail out if empty").
- Section banners:
// ── Render ──,# ---- helpers ----,{/* Actions */},# 1. fetch / # 2. transform. - Anything a type, name or signature already says.
- Standard framework behaviour: what
useEffectdoes, what a Radix primitive renders, how React Query caches, what a DRF ViewSet is, what@shared_taskdoes. - History: what a change fixed, what used to be there, how many call sites there once were, PR numbers, incident dates. Gravestones for deleted code go with it.
- Plan-phase labels —
P0,Phase N,WS-H,Fork 3,Gap 2— in code, comments, test names and filenames alike. - JSDoc or a docstring that only re-spells the export name.
Keep, compressed to one or two lines
- A non-obvious design decision, and why.
- A workaround for a framework, browser, API or third-party limitation.
- An edge case, anomaly, or intentionally counterintuitive behaviour.
- A performance, security, contrast, compatibility or correctness constraint.
- An external invariant: a backend contract, a wire format, a required ordering, a provider limit, a token the design system pins.
- A trap where the obvious simplification breaks something.
- Why an empty
catch {}/except: pass/ no-op guard is deliberate.
Write WHY, not WHAT. Never grow a short useful comment into prose.
Large blocks
Multi-paragraph module headers and JSDoc essays are the main offender. Do not tidy
them — delete them, and keep only the constraint they contained. A module named
colors.ts exporting TONE_CHIP does not need six paragraphs saying it is about
colour. Turning a 20-line essay into a 15-line essay is a failure: it collapses to a
line or two, or it goes.
Show full SKILL.md (245 more words)Show less
Python specifics
A docstring is not automatically safe — judge it like a comment. Delete one that only
re-spells the name ("""Serializer for EvalRun."""), and delete Args/Returns blocks
that restate typed parameters. Keep a parameter line only for a unit, a range, an
ownership rule or a caller obligation the type cannot express.
Keep, compressed: idempotency and retry expectations on a Celery task, which queue a
task must run on, transaction and locking order, and why a write uses
.filter().update() — that pattern is deliberate here, it skips signals and leaves
the in-memory object stale.
Never remove
biome-ignore, @ts-expect-error, # noqa, # type: ignore, # pragma: no cover,
# fmt: off, eslint-*, @vitest-environment, "use client", shebangs, license
headers and generated-file banners. Django verbose_name / help_text are UI
strings, not comments.
Evaluate each TODO/FIXME on its merits. Keep one that names real outstanding work.
Prompt text inside a string literal is DATA, not commentary. Never edit inside a string, f-string or triple-quoted block that is assigned, returned or passed as an argument, however much it reads like prose.
Two local traps
frontend/scripts/check-design.shgreps source TEXT, comments included. A comment containing a banned literal (uppercase,page-title) fails the build. Reword it.- A DRF view docstring becomes the OpenAPI operation
description. Deleting one changes the generated client, so prefer an explicit@extend_schema(summary=...).
End state
Very few comments. A well-written file may legitimately have none. Do not keep a comment because having some feels safer, and do not strip a load-bearing constraint to lower the count.
© overmind-core, AGPL-3.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file
Files
Just SKILL.md in .agents/skills/code-comments of overmind-core/overmind.
Open the folder on GitHubat commit 3dec73c
Compare with similar skills
Code Comments next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.
| Skill | Stars | Used in | Tokens | Auto-check | Licence | Repo updated |
|---|---|---|---|---|---|---|
| Code Comments this skillovermind-core/overmind | 597 | — | ~1.1k | Automated safety check: Pass | AGPL-3.0 | |
| Diagram Designcathrynlavery/diagram-design | 45k | 1 repos | ~7.5k | Automated safety check: Pass | MIT | |
| Simple Englishmoeru-ai/airi | 50k | 2 repos | ~4.6k | Automated safety check: Pass | MIT | |
| Get API Docs with chubandrewyng/context-hub | 14k | 2 repos | ~775 | Automated safety check: Pass | MIT | |
| Doc SyncJetBrains/ideavim | 10k | 2 repos | ~2.6k | Automated safety check: Pass | MIT | |
| Mailspring App ScreenshotsFoundry376/Mailspring | 18k | — | ~1.5k | Automated safety check: Pass | GPL-3.0 |
Similar skills
Simple English
moeru-ai/airi
Write or rewrite technical text with the rules of ASD-STE100 Simplified Technical English so it is clear, unambiguous, and free of AI slop.
Get API Docs with chub
andrewyng/context-hub
Fetches current documentation for third-party APIs and SDKs with the chub CLI before the agent writes code against them, instead of relying on remembered API shapes.
- Official
Doc Sync
JetBrains/ideavim
Keeps IdeaVim documentation in sync with code changes. An agent skill from JetBrains/ideavim.
Mailspring App Screenshots
Foundry376/Mailspring
Captures screenshots of the running Mailspring dev app for docs, PRs or visual checks by launching it with a debugging port, driving the UI and clipping to an element.
Draw.io Diagram Studio
Agents365-ai/drawio-skill
Creates and edits editable draw.io diagrams from descriptions, code, infrastructure files, SQL and API schemas, with sync, review, test and export tools.
More from overmind-core/overmind
All 20 skills in this repoAPI Endpoints
overmind-core/overmind
End-to-end workflow for adding or changing a backend API endpoint — which module the serializer and view belong in, URL registration, OpenAPI client regeneration, and typed consumption from the…
Finetuning Model Onboarding
overmind-core/overmind
Rules for adding a new model or model family to the finetuning pipeline, or changing finetuning behavior for an existing one — engine-agnostic customization via family hooks instead of if/else in…
Frontend Design
overmind-core/overmind
Overmind Console design system — semantic tokens, shared primitives, geometry and icons, the border-contrast floor, the duplicated table implementations, and the verification scripts.
MCP
overmind-core/overmind
End-to-end workflow for adding or changing Overmind MCP tools, resources, prompts, authentication, or result contracts — server layers, catalog registration, MCP-impact classification, and required…
PR Etiquette
overmind-core/overmind
How to open a complete pull request on overmind-core/overmind — the CI gates, the cross-cutting surfaces a change must carry with it (MCP, blast radius, the docs repo), gh pr edit being broken here…
Seed Demo Data
overmind-core/overmind
Run or modify the seeddemo management command (the one-project Support Copilot demo) without breaking the beat-safety invariants that keep celery workers from re-driving seeded rows.
Related
Categories
Questions about Code Comments
What does Code Comments do?
Full comment and docstring policy for this repo — what to delete, what to keep compressed, what to never touch, and the two local traps. Code Comments is an agent skill from overmind-core/overmind. Full comment and docstring policy for this repo — what to delete, what to keep compressed, what to never touch, and the two local traps.
When should I use Code Comments?
Code Comments fits situations like: pruning comments and docstrings in any language; tasks that involve Technical documentation.
How do I install Code Comments in Claude Code?
Run `npx skills add overmind-core/overmind --skill code-comments -a claude-code`. Or copy the skill folder (.agents/skills/code-comments in overmind-core/overmind) into .claude/skills/code-comments in your project. Claude Code loads it when a task matches its description.
How do I install Code Comments in Codex?
Run `npx skills add overmind-core/overmind --skill code-comments -a codex`. Or copy the skill folder (.agents/skills/code-comments in overmind-core/overmind) into .agents/skills/code-comments in your project. Codex loads it when a task matches its description.
Can I use Code Comments in Cursor, Gemini CLI or GitHub Copilot?
Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add overmind-core/overmind --skill code-comments -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/code-comments, .gemini/skills/code-comments, .github/skills/code-comments and .opencode/skills/code-comments in your project.
What does Code Comments need to run?
SKILL.md names no scripts, command-line tools or credentials: Code Comments is instructions for the agent only. Our summary lists: Python 3.
Does Code Comments access the network?
SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.
Is Code Comments safe to install?
Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.
What licence does Code Comments use?
Code Comments is published under the AGPL-3.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.
How many tokens does Code Comments use?
About 1.1k tokens (SKILL.md is roughly 4.2k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.
What are the alternatives to Code Comments?
Skills that share tags, products or a category with Code Comments: Diagram Design (cathrynlavery/diagram-design, 45k stars), Simple English (moeru-ai/airi, 50k stars), Get API Docs with chub (andrewyng/context-hub, 14k stars) and Doc Sync (JetBrains/ideavim, 10k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
Who maintains Code Comments?
overmind-core (a GitHub organization) maintains it in overmind-core/overmind, which has 597 GitHub stars. The repository holds 20 skills in this directory. The repository was last updated on October 8, 2026.
Source: overmind-core/overmind on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.