本文へ移動
cccskills
無料GitHub で公開

code-comment-discipline

Apply whenever writing or editing source code in any core's build agent (backend-eng, ui-builder, or equivalent). Governs when a comment belongs at all and what it may say. Default is no comment; a comment is only for the non-obvious. Never restates what the code does, never narrates the task, fix, or conversation that produced it.

インストール方法を見る

含まれるファイル(1)

  • SKILL.md2.2 KB

SKILL.md(原文)

インストールする前に、エージェントに与えられる指示の中身を確認できます。

Code Comment Discipline

Well-named identifiers and clear structure explain what code does. A comment earns its place only when it explains something the code cannot: a hidden constraint, a non-obvious invariant, a workaround for a specific external bug, or behavior that would surprise a reader.

Default: no comment

Most lines, functions, and blocks need zero comments. Before writing one, check whether the same clarity is reachable by renaming a variable or function instead — prefer that over a comment every time.

When a comment is allowed

Only for the non-obvious:

  • A constraint imposed from outside the code (an API's undocumented limit, a browser quirk, a platform requirement) that isn't visible at the call site.
  • An invariant the code relies on that isn't implied by types or names (e.g. "callers must hold the lock before this runs").
  • A deliberate workaround for a specific bug in a dependency, with enough detail to know when it's safe to remove.
  • Behavior that looks like a mistake but is intentional.

What a comment must never say

  • What the code does — that's the identifier's job, not the comment's.
  • Why this task needed the change, who asked for it, or which ticket, issue, or conversation prompted it.
  • History: "used to be X," "changed from Y," "removed Z," "previously," "now we," or any other before/after narration. A comment states the current state and its non-obvious reason only, never how it got there.
  • A restatement of the function/variable name in prose ("increments the counter" above counter++).

Applying to existing comments

When editing a file that already has comments violating these rules, remove or rewrite them as part of the same change rather than leaving them in place — don't let a nearby edit normalize the pattern.

レビュー

まだレビューはありません。使ってみた感想をお寄せください。

同じリポジトリのスキル

概要と使いどころ

Push the LLM to reconsider, refine, and improve its recent output. Use when user asks for deeper critique or mentions a known deeper critique method, e.g. socratic, first principles, pre-mortem, red team

日本語の概要は準備中です。原文の説明を表示しています。

skyf0xx/hedgehog442026年10月11日 更新

Facilitate a brainstorming session using diverse creative techniques. Use when the user says 'help me brainstorm' or 'help me ideate'

日本語の概要は準備中です。原文の説明を表示しています。

skyf0xx/hedgehog442026年10月11日 更新

Research a topic to support a decision, three ways: draft a research prompt for the user to run in their own tool (ChatGPT, Gemini, Grok, Perplexity, …), turn a finished research report into a short summary with cited sources that other skills can use directly, or run the research here with parallel web searches. Built-in research types: market, domain, technical, competitive, user-voice, academic-lit; also supports choosing between candidates, and custom types via overrides. Use when the user says "deep recon", "research this", "draft a research prompt", "process this research report", "market research", "domain research", "technical research", "competitor research", "literature review", or "help me choose between"

日本語の概要は準備中です。原文の説明を表示しています。

skyf0xx/hedgehog442026年10月11日 更新

Test a half-formed idea in a questioning conversation, with different personas probing its weak points, until the user can act on it or drop it with confidence. Optionally writes a short brief for planning skills to build on. Use when the user says 'forge an idea', 'pressure-test this idea', 'stress-test my thinking', or 'harden this idea'

日本語の概要は準備中です。原文の説明を表示しています。

skyf0xx/hedgehog442026年10月11日 更新

bmad-prd

無料

Create, update, or validate a PRD. Use when the user wants help producing, editing, or validating a PRD

日本語の概要は準備中です。原文の説明を表示しています。

skyf0xx/hedgehog442026年10月11日 更新

Test a product concept with Amazon's Working Backwards method: write the press release for the finished product first, then answer hard customer and stakeholder questions, ending in a complete PRFAQ document. Use when the user requests to 'create a PRFAQ', 'work backwards', or 'run the PRFAQ challenge'

日本語の概要は準備中です。原文の説明を表示しています。

skyf0xx/hedgehog442026年10月11日 更新

skyf0xx のスキルをすべて見る

このスキルの問題を報告する