code-comment-standards

Validate code comments for required Work Item ID formatting.

Updated Aug 27, 2026

Search Tags:#review #comments #traceability #code #work-item #wi-id

Ready to run

npx skills add https://github.com/j-mckerracher/agent-research --skill code-comment-standards-j-mckerracher

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: code-comment-standards
Source: https://github.com/j-mckerracher/agent-research/tree/main/dated-agents/4-6-2026/.claude/skills/code-comment-standards
Command: npx skills add https://github.com/j-mckerracher/agent-research --skill code-comment-standards-j-mckerracher

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Shared standards ensure that code comments referencing acceptance criteria, stories, tickets, or work items include a Work Item ID (WI-ID) for traceability and auditability.

Core Features & Use Cases

Enforces inclusion of WI-ID in inline and block comments, TODOs, and review notes tied to tracked work items.
Guides writers to format WI references consistently and prevents non-compliant comments from slipping into production.
Useful during code reviews, pair programming, and automated scans to maintain story-driven documentation.

Quick Start

Review newly added or existing code comments and ensure each reference to a story or work item includes a WI-ID formatted like WI-XXXXXXX.

Frequently Asked Questions about code-comment-standards

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I enforce work item traceability in code comments?▼

Enforce work item traceability by requiring a Work Item ID (WI-ID) in inline comments, block comments, TODOs, and review notes. Validate the presence and formatting of WI references to maintain story-driven documentation before merging code.

What is the correct format for referencing a work item ID in a code comment?▼

The correct format for referencing a work item ID in a code comment follows the pattern WI-XXXXXXX. Consistent formatting ensures traceability and prevents non-compliant references from slipping into production codebases.

How do I check code comments for missing work item IDs during a review?▼

Check code comments for missing work item IDs by scanning newly added or existing inline comments, TODOs, and review notes. Guide writers to correct non-compliant references that lack a properly formatted WI-ID before code is merged.

Can I use this to validate WI-ID references in TODOs and review notes?▼

Yes, you can validate WI-ID references in TODOs and review notes. The standard applies across production codebases wherever comments reference stories, tickets, or acceptance criteria, ensuring every tracked item is properly documented.

Do I need a specific work item tracker to format code comments with a WI-ID?▼

No specific work item tracker is required to format code comments with a WI-ID. The standard focuses on validating the presence and consistent formatting of references like WI-XXXXXXX across any tracked stories or tickets.

Why are non-compliant code comments without a WI-ID blocked before merging?▼

Non-compliant code comments without a WI-ID are blocked before merging to ensure auditability and traceability. Shared standards require that comments referencing acceptance criteria, stories, or tickets include a Work Item ID for production codebases.