_traceability-check

Validate commit and PR descriptions against changed file lists.

2|Updated Nov 2, 2025

Search Tags:#documentation #traceability #change-management #pr-description #commit-description

Ready to run

npx skills add https://github.com/wxy/SilentFeed --skill traceability-check-wxy

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: _traceability-check
Source: https://github.com/wxy/SilentFeed/tree/main/.copilot/skills/_traceability-check
Command: npx skills add https://github.com/wxy/SilentFeed --skill traceability-check-wxy

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This script validates that the descriptive text for changes accurately covers the actual files touched, ensuring commit and PR descriptions stay in sync with code changes and preventing omissions.

Core Features & Use Cases

Coverage validation: checks commits and PR descriptions against the list of changed files.
Gap reporting: flags files that lack corresponding descriptions in COMMIT_DESCRIPTION.local.md or PR_DESCRIPTION.local.md.
Remediation guidance: suggests precise edits to maintain traceability.

Quick Start

Run the traceability check on your staged changes to ensure every touched file has a matching description.

Frequently Asked Questions about _traceability-check

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

FAQPage Schema

How do I check if my commit description covers all changed files?▼

To check commit description coverage, compare the staged file list against COMMIT_DESCRIPTION.local.md content. This traceability validation flags any touched files lacking corresponding descriptions to prevent omissions.

What is documentation traceability in change management?▼

Documentation traceability in change management ensures code changes stay synchronized with descriptive text. It validates alignment between PR_DESCRIPTION.local.md content and actual modified files to prevent drift and omissions.

How do I prevent documentation drift when modifying code?▼

Prevent documentation drift by validating that every touched file has a matching entry in COMMIT_DESCRIPTION.local.md or PR_DESCRIPTION.local.md. Gap reporting identifies undocumented changes and suggests precise remediation edits.

Do I need specific dependencies to validate PR descriptions against staged changes?▼

No specific dependencies are required to validate PR descriptions. The traceability check operates directly on your staged file list and description documents to report gaps without external components.

What is the best way to align PR descriptions with actual touched files?▼

The best way to align PR descriptions is automated gap reporting that compares PR_DESCRIPTION.local.md against the committed file list. It flags missing file descriptions and provides remediation guidance to maintain traceability.

What happens when a changed file is missing from the PR description?▼

When a changed file is missing from the PR description, the traceability check reports the gap and suggests precise edits to maintain documentation alignment, ensuring no code modifications go undocumented.