comment-quality

Featured

Review and fix temporal references in code comments.

AI & Automation 419 stars 44 forks Updated 2 days ago MIT

Install

View on GitHub

Quality Score: 95/100

Stars 20%
87
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# Comment Quality Skill Review code comments for temporal references, development-activity language, and relative comparisons. Produces structured reports with actionable rewrites that explain WHAT the code does and WHY, only WHAT the code does and WHY. Supports `.go`, `.py`, `.js`, `.ts`, `.md`, and `.txt` files. ## Instructions ### Phase 1: SCAN **Goal**: Identify all comments containing temporal, activity, or relative language. **Step 1: Determine scope** Read the repository CLAUDE.md first to pick up any project-specific comment conventions. Scan only what was requested. If user specifies files, scan those files. If user specifies a directory, scan that directory. Honor the explicit scope -- even if you suspect other files have issues, honor the explicit scope and suggest expansion separately at the end. If user explicitly requests auto-fix, enable it. Otherwise present findings for review. For large codebases, group findings by directory when reporting. **Step 2: Search for temporal patterns** Flag every instance of the following categories. No temporal word is "harmless" -- all temporal language ages poorly and must be rewritten regardless of how innocuous it seems: - **Temporal words**: "new", "old", "previous", "current", "now", "recently", "latest", "modern" - **Development activity**: "added", "removed", "deleted", "updated", "changed", "modified", "fixed", "improved", "enhanced", "refactored", "optimized" - **State transitions**: "replaced", "migrated", ...

Details

Author
notque
Repository
notque/vexjoy-agent
Created
5 months ago
Last Updated
2 days ago
Language
Python
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category

AI & Automation Listed

high-quality-code-comments

Use when adding, reviewing, or improving TypeScript/JavaScript comments, TSDoc, JSDoc, exported API docs, public interfaces, complex functions, invariants, edge cases, or non-obvious implementation choices.

0 Updated 1 months ago
moorage
AI & Automation Listed

commenting-code

Writes and reviews code comments that preserve non-obvious intent, contracts, invariants, and failure semantics without narrating the code. Uses clear layer placement (interface, implementation, cross-module) and lightweight review checks to keep comments accurate over time. Use when adding or reviewing inline comments, docstrings, API docs, or design notes for behavior that could be misunderstood.

0 Updated 4 weeks ago
msewell
Code & Development Listed

awesome-code-cleanup

Repo-wide cleanup of AI-like code noise, behavior-preserving: a comment pass (delete narration, condense bloat, fix stale, keep load-bearing), a read-only audit mode, an opt-in refactor mode for vague names and over-abstraction, a detection mode for dead code and logical inconsistencies, and an execution mode that applies another audit's findings. Use when asked to clean up or condense comments, de-slop vibe-coded files, apply a YAGNI pass, find dead code, apply a slop-audit report, or 'почисти код', 'найди мёртвый код'. Do not use for prose (awesome-humanize-en, awesome-document-style) or for the read-only marker sweep (awesome-slop-audit), whose report it executes.

8 Updated today
khasky