Add comment-audit skill for code documentation quality#341
Closed
juliarvalenti wants to merge 1 commit into
Closed
Add comment-audit skill for code documentation quality#341juliarvalenti wants to merge 1 commit into
juliarvalenti wants to merge 1 commit into
Conversation
Audits code comments for temporal/historical notes, overly long narration, and over-referencing of external artifacts. Reviews the PR diff by default or the whole codebase with --all, dispatching the high-volume pattern-matching to a cheap Haiku subagent.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Introduces a new Claude skill for auditing code comments and inline documentation. The skill identifies and flags three common comment quality issues: temporal/historical notes, overly long narration, and over-referencing of external artifacts (issues, PRs, plan steps). This helps maintain clean, focused documentation that explains what the code does now rather than its lineage or exhaustive context.
Changes
.claude/skills/comment-audit/SKILL.mdwith complete skill definition including:Testing
N/A — this is a skill definition document with no executable code or tests.
Related Issues
None
https://claude.ai/code/session_01SP7avU9N61aWhawc7ivpcv