Enforce Conventional Comments formatting on source code comments.
npx skills add https://github.com/erichugy/agentic.skills --skill code-comments-erichugy
Please help me install this Agent Skill. Skill: code-comments Source: https://github.com/erichugy/agentic.skills/tree/main/code-comments Command: npx skills add https://github.com/erichugy/agentic.skills --skill code-comments-erichugy
Unclear, noisy, or outdated code comments obscure intent, create maintenance overhead, and hide technical debt. This Skill provides a simple, consistent convention to make comments actionable and maintainable by focusing on intent rather than restating code.
Review the repository's code comments and convert or annotate them to follow the Conventional Comments format, ensuring each labeled comment explains why rather than what and using decorations to indicate blocking or issue references.
High-intent search queries and answers about installing and using this skill.
You can enforce consistent code comments by applying Conventional Comments formatting with standard labels like TODO, FIXME, and HACK. This ensures comments explain intent and action, while respecting project-specific AGENTS.md or CLAUDE.md overrides.
The best way to write code comments is to follow the core rule: only comment the why, never the what. Use Conventional Comments labels and optional decorations to express urgency or linkages, reducing noisy or redundant annotations.
During a PR review, use Conventional Comments decorations to annotate code with parenthetical labels like blocking, non-blocking, or issue references. This categorizes comment intent and validates priority across repository workspaces.
Yes, you can override Conventional Comments formatting by defining custom rules in your repository's AGENTS.md or CLAUDE.md files. The skill respects these project-specific overrides when validating labels and decorations.
You should remove commented-out code because it obscures intent and creates maintenance overhead. Conventional Comments advises deleting redundant annotations and focusing on documenting the why to improve overall comment quality.
Conventional Comments provides standard labels including TODO, FIXME, HACK, BUG, NOTE, QUESTION, OPTIMIZE, and DEPRECATED. These labels categorize comment intent to make code annotations actionable and maintainable.
mgratzerCreate CLAUDE.md, AGENTS.md, docs/, README, and CHANGELOG.md for Forge projects.
othercodeReview Python code comments and docstrings for redundancy.
webdriverioEnforce global comment style and coverage standards in Claude Code projects.
nikhillinitDetect security vulnerabilities, secrets, and misconfigurations in codebases.
