comment-guidelines
CommunityClarify why, not what, in every comment.
Authorahonn
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This policy makes code maintenance easier by removing redundant comments and ensuring remaining comments explain the reasoning behind decisions, not the obvious implementation.
Core Features & Use Cases
- Removes comments that restate what the code does, keeping only rationale and design decisions.
- Encourages explicit WHY explanations for non-obvious behavior, edge cases, and interfaces.
- Automatically applies guidelines during edits to improve readability and maintainability.
Quick Start
Apply the WHY over WHAT principle to all new and existing comments during code edits.
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: comment-guidelines Download link: https://github.com/ahonn/dotfiles/archive/main.zip#comment-guidelines Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.