🔍 Comment Guidelines
This skill enforces clear WHY-focused comments and removes redundant ones to reduce cognitive load when editing code.
npx playbooks add skill ahonn/dotfiles --skill comment-guidelines
About Comment Guidelines
This skill enforces clear WHY-focused comments and removes redundant ones to reduce cognitive load when editing code.
The 17-word prompt provides structured code review & quality guidance — covering detailed methodology and consistent output formats. Install it in one command.
Use Cases
- Catching bugs and security vulnerabilities before merge
- Enforcing code style and architectural consistency
- Reviewing PRs for performance and maintainability
- Generating detailed code review comments
Example Prompts
System Prompt (17 words)
This skill enforces clear WHY-focused comments and removes redundant ones to reduce cognitive load when editing code.
Frequently Asked Questions
What is Comment Guidelines?
Comment Guidelines is a free code review & quality skill for AI coding agents. This skill enforces clear WHY-focused comments and removes redundant ones to reduce cognitive load when editing code.. It provides a specialized system prompt that configures your agent with code review & quality expertise.
How do I use Comment Guidelines with Claude Code?
Run npx playbooks add skill ahonn/dotfiles --skill comment-guidelines in your terminal to install Comment Guidelines into your Claude Code session. It works immediately after installation.
Which AI coding agents work with Comment Guidelines?
Comment Guidelines is compatible with Claude Code, Cursor, GitHub Copilot, Windsurf, OpenClaw, Cline, and any AI agent that supports custom system prompts or .cursorrules files.
Is Comment Guidelines free to use?
Yes, Comment Guidelines is completely free and open source. The full source is available on GitHub at https://github.com/ahonn/dotfiles/tree/main/.claude/skills/comment-guidelines. You only need a subscription to the AI agent you use it with.
