Official agent skill

Writing Code Comments

by PostHog in PostHog/posthog

Gates whether a code comment should exist and forces the ones that stay to explain why, not what.

OfficialCustom licenceAuto-check passedDevelopment

Install Writing Code Comments

skills CLI
$ npx skills add PostHog/posthog --skill writing-code-comments -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install PostHog/posthog writing-code-comments --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/PostHog/posthog.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/writing-code-comments .claude/skills/writing-code-comments && rm -rf skills-src

Use ~/.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/

Facts

Skill name
writing-code-comments
GitHub stars
40k
Token cost
~1.6k tokens
SKILL.md length
869 words
Files
1
Skills in repo
252
Repo updated
First seen
Licence
Custom licence

At a glance

Gates whether a code comment should exist and forces the ones that stay to explain why, not what.

  • Tasks that involve Technical documentation
  • SKILL.md covers The gate: one question, Delete these, Keep these and Style, plus 1 more section
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
  • Tasks that involve Text to speech and voice

What it does

Writing Code Comments is an agent skill from PostHog/posthog, published by the product's own GitHub organization. Gates whether a code comment should exist and forces the ones that stay to explain why, not what. Use ALWAYS before writing or editing a comment in any language (Python, TypeScript, Go, Rust, SQL), and when reviewing a diff that adds comments. Removes the comment types that clutter the codebase: narration that restates the code, change-history and chat-context notes ("previously did X", "per PR 123", "AI:"), perishable measurements and current-state stamps ("~20 min build", "currently", "today"), commented-out…

Its SKILL.md is about 1.6k 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 and Text to speech and voice. It works with Python, Rust, SQL and TypeScript. The repository describes itself as: :hedgehog: PostHog is the leading platform for building self-driving products. Our developer tools – AI observability, analytics, session replay, flags, experiments, error…

When your agent uses it

  • Tasks that involve Technical documentation
  • Tasks that involve Text to speech and voice

Example prompts

  • “previously did X”
  • “per PR 123”
  • “), perishable measurements and current-state stamps (”
  • “/writing-code-comments”

Requirements

  • Python 3

What it can do on your machine

Read from SKILL.md and the folder at commit 10f9ad7. 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

Writing Code Comments loads about 1.6k tokens when it runs. Until then it costs about 201 tokens; SKILL.md has 869 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~201
When it runs · the whole SKILL.md, loaded when a task matches
~1.6k

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

Its licence (Custom licence) doesn't allow us to republish the file, so here is its outline and opening line. It has 869 words (~1,588 tokens).

“Run this before adding or editing any comment. The default is no comment. Good code with clear names carries most of its meaning on its own; a comment earns its place only when it tells a reader something the code…”

— opening of SKILL.md by PostHog, Custom licence
name
writing-code-comments

Read the full SKILL.md on GitHub

Files

Just SKILL.md in .agents/skills/writing-code-comments of PostHog/posthog.

Open the folder on GitHubat commit 10f9ad7

Used in 1 other repository

We found 1 copy of this SKILL.md (exact, near-identical or edited) in other folders. This page covers the copy in PostHog/posthog, which our catalogue first saw on October 8, 2026.

Compare with similar skills

Writing 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.

Writing Code Comments compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Writing Code Comments this skillPostHog/posthog40k—~1.6kAutomated safety check: PassCustom licence
Coding Agentmastra-ai/mastra29k—~2.3kAutomated safety check: PassCustom licence
New Pattern Authoring WorkflowTotoro-jam/battle-tested-patterns344—~1.5kAutomated safety check: PassMIT
Generating Documentationancoleman/ai-design-components526—~3kAutomated safety check: PassMIT
jscpd Code Migration Trackerkucherenko/jscpd6.4k—~5kAutomated safety check: PassMIT
Cross-Language Coding Standardszereight/gitlab-mcp2k1 repos~1.4kAutomated safety check: PassMIT

Similar skills

  • Coding Agent

    mastra-ai/mastra

    Authoring playbook for building agents that write, edit, review, or refactor code.

    29k GitHub stars~2.3k tokensUpdated today
    DevelopmentAuto-check passed
  • New Pattern Authoring Workflow

    Totoro-jam/battle-tested-patterns

    Step-by-step workflow for adding a new pattern to the battle-tested-patterns repo: validate the topic, verify sources, write the doc, code and exercises.

    344 GitHub stars~1.5k tokensUpdated 1 mo ago
    DevelopmentAuto-check passed
  • Generating Documentation

    ancoleman/ai-design-components

    Generate comprehensive technical documentation including API docs (OpenAPI/Swagger), code documentation (TypeDoc/Sphinx), documentation sites (Docusaurus/MkDocs), Architecture Decision Records…

    526 GitHub stars~3k tokensUpdated 10 mo ago
    DevelopmentAuto-check passed
  • Measures a code port between languages or frameworks with jscpd's function-level comparison, porting tests before code and tracking what is left unmatched.

    6.4k GitHub stars~5k tokensUpdated today
    DevelopmentAuto-check passed
  • Shared reference for naming, function size, complexity and error handling rules that reviewer agents apply across TypeScript, Python, Go, Rust, Java, C# and Swift.

    2k GitHub starsUsed in 1 repo~1.4k tokens
    DevelopmentAuto-check passed
  • Code Migration

    anthropics/code-migration-kit-with-claude-code

    Official

    Run a large-scale language migration with the six-step process: create the map and the rules, stress-test the rules, translate everything, compile, run it, match behavior.

    743 GitHub stars~983 tokensUpdated 3 mo ago
    DevelopmentAuto-check passed

More from PostHog/posthog

All 252 skills in this repo
  • Authoring Log Alerts

    PostHog/posthog

    Official

    Author useful, low-noise log alerts on services in a PostHog project.

    40k GitHub stars~3k tokensUpdated today
    Auto-check passed
  • Official

    Operating procedure for the conflict-autoresolver agent: sweep open PostHog/posthog PRs that conflict with master, resolve the trivial conflicts (generated artifacts deterministically, source…

    40k GitHub stars~4.2k tokensUpdated today
    Auto-check passed
  • Official

    Help users debug PostHog Error Tracking stack-trace symbolication for any supported platform — JavaScript/TypeScript web, React Native (Hermes), Android (Proguard / R8), or iOS / macOS (dSYM).

    40k GitHub stars~2.2k tokensUpdated today
    Auto-check passed
  • Exploring Apm Traces

    PostHog/posthog

    Official

    Investigates distributed application performance using PostHog APM (OpenTelemetry span) data via MCP.

    40k GitHub stars~3.5k tokensUpdated today
    Auto-check passed
  • Exploring LLM Traces

    PostHog/posthog

    Official

    Debug and inspect LLM/AI agent traces using PostHog's MCP tools.

    40k GitHub stars~4.4k tokensUpdated today
    Auto-check passed
  • Investigate Metric

    PostHog/posthog

    Official

    Diagnose why a product metric changed (dropped, spiked, or plateaued) by orchestrating breakdowns, actors, paths, lifecycle, retention, and annotations queries.

    40k GitHub stars~1.9k tokensUpdated today
    Auto-check passed

Categories

Questions about Writing Code Comments

What does Writing Code Comments do?

Gates whether a code comment should exist and forces the ones that stay to explain why, not what. Writing Code Comments is an agent skill from PostHog/posthog, published by the product's own GitHub organization. Gates whether a code comment should exist and forces the ones that stay to explain why, not what.

When should I use Writing Code Comments?

Writing Code Comments fits situations like: tasks that involve Technical documentation; tasks that involve Text to speech and voice.

How do I install Writing Code Comments in Claude Code?

Run `npx skills add PostHog/posthog --skill writing-code-comments -a claude-code`. Or copy the skill folder (.agents/skills/writing-code-comments in PostHog/posthog) into .claude/skills/writing-code-comments in your project. Claude Code loads it when a task matches its description.

How do I install Writing Code Comments in Codex?

Run `npx skills add PostHog/posthog --skill writing-code-comments -a codex`. Or copy the skill folder (.agents/skills/writing-code-comments in PostHog/posthog) into .agents/skills/writing-code-comments in your project. Codex loads it when a task matches its description.

Can I use Writing 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 PostHog/posthog --skill writing-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/writing-code-comments, .gemini/skills/writing-code-comments, .github/skills/writing-code-comments and .opencode/skills/writing-code-comments in your project.

What does Writing Code Comments need to run?

SKILL.md names no scripts, command-line tools or credentials: Writing Code Comments is instructions for the agent only. Our summary lists: Python 3.

Does Writing 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 Writing 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 Writing Code Comments use?

Writing Code Comments has a licence file (the repository's licence) that doesn't match a standard licence. Read it on GitHub before reusing the skill.

How many tokens does Writing Code Comments use?

About 1.6k tokens (SKILL.md is roughly 6.4k 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 Writing Code Comments?

Skills that share tags, products or a category with Writing Code Comments: Coding Agent (mastra-ai/mastra, 29k stars), New Pattern Authoring Workflow (Totoro-jam/battle-tested-patterns, 344 stars), Generating Documentation (ancoleman/ai-design-components, 526 stars) and jscpd Code Migration Tracker (kucherenko/jscpd, 6.4k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Writing Code Comments?

PostHog (a GitHub organization, an official publisher) maintains it in PostHog/posthog, which has 40,182 GitHub stars. The repository holds 252 skills in this directory. The repository was last updated on October 8, 2026.

Source: PostHog/posthog on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.