Back to Skills

comment-cleanup

verified

Guidelines for comments in code. Use when adding, editing, or removing comments.

View on GitHub

Marketplace

motlin-claude-code-plugins

motlin/claude-code-plugins

Plugin

code

productivity

Repository

motlin/claude-code-plugins
3stars

plugins/code/skills/comment-cleanup/SKILL.md

Last Verified

January 24, 2026

Install Skill

Select agents to install to:

Scope:
npx add-skill https://github.com/motlin/claude-code-plugins/blob/main/plugins/code/skills/comment-cleanup/SKILL.md -a claude-code --skill comment-cleanup

Installation paths:

Claude
.claude/skills/comment-cleanup/
Powered by add-skill CLI

Instructions

# Comment Guidelines

- Use comments sparingly
- Don't comment out code
  - Remove it instead
- Don't add comments that describe the process of changing code
  - Comments should not include past tense verbs like added, removed, or changed
  - Example: `this.timeout(10_000); // Increase timeout for API calls`
  - This is bad because a reader doesn't know what the timeout was increased from, and doesn't care about the old behavior
- Don't add comments that emphasize different versions of the code, like "this code now handles"
- Do not use end-of-line comments
  - Place comments above the code they describe

Validation Details

Front Matter
Required Fields
Valid Name Format
Valid Description
Has Sections
Allowed Tools
Instruction Length:
600 chars