commit-with-req-tag

Create git commits linking code to REQ-*, BR-*, and C-* tags.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/foolishimp/ai_sdlc_method --skill commit-with-req-tag
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: commit-with-req-tag
Source: https://github.com/foolishimp/ai_sdlc_method/tree/main/plugins/code-skills/skills/tdd/commit-with-req-tag
Command: npx skills add https://github.com/foolishimp/ai_sdlc_method --skill commit-with-req-tag

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Maintaining clear, bidirectional traceability between code changes and requirements is crucial for compliance, impact analysis, and documentation, but is often a manual and error-prone process.

Core Features & Use Cases

  • Semantic Commit Generation: Crafts detailed commit messages following semantic commit conventions (e.g., feat:, fix:).
  • Requirement Traceability: Automatically embeds REQ-, BR-, and C-* keys in commit messages for complete bidirectional linkage.
  • TDD Workflow Integration: The final, automated step in the RED → GREEN → REFACTOR → COMMIT cycle, ensuring a complete audit trail.
  • Use Case: After completing the TDD cycle for a user login feature, use this skill to create a final commit that clearly links the implemented code to REQ-ID 'UserLogin' and its associated business rules.

Quick Start

Create a final git commit for REQ-ID 'UserLogin', summarizing the implemented feature and linking to BR-001, BR-002, and BR-003.

Frequently Asked Questions about commit-with-req-tag

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

FAQPage Schema
How do I link git commits to requirements for traceability?

Link commits to requirements by embedding REQ-*, BR-*, and C-* keys in commit messages. This Skill generates semantic commit messages with requirement tags in the footer, creating bidirectional traceability between code changes and documented requirements for compliance and impact analysis.

What should a commit message include for requirement traceability?

A traceability commit message includes a semantic prefix (feat:, fix:), a subject line, a body describing changed files and test coverage, and a footer listing all REQ-*, BR-*, and C-* keys. This structure enables forward lookup from requirements to code and backward lookup from commits to requirements.

How do I automate commit messages in a TDD workflow?

After completing the red-green-refactor cycle, use this Skill as the final step to automatically generate a complete commit message. It collects requirement IDs, business rules, and constraints, then outputs a semantic commit with full traceability metadata in a single structured message.

Can I use requirement tags with git for compliance documentation?

Yes. Semantic commits with embedded REQ-*, BR-*, and C-* tags create audit trails linking implemented features to specific requirements and business rules. This enables compliance verification, impact analysis, and automated traceability reports directly from your git history.

What are the prerequisites before creating a traced commit?

Before committing, identify all relevant requirement IDs (REQ-*), business rules (BR-*), and constraints (C-*) for your changes, complete the red-green-refactor TDD cycle, and finalize all code and test modifications. The Skill then generates the traced commit message from these inputs.