audit-codebase

Audit codebases against software-simplicity principles and produce evidence-cited scorecards.

2|2|Updated Dec 23, 2017
One-click install
npx skills add https://github.com/xriu/dotfiles --skill audit-codebase-xriu
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: audit-codebase
Source: https://github.com/xriu/dotfiles/tree/main/home/.skills/audit-codebase
Command: npx skills add https://github.com/xriu/dotfiles --skill audit-codebase-xriu

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Engineering teams lack a consistent, evidence-based way to evaluate whether a design, pull request, or repository follows software-simplicity principles, making maintainability reviews subjective and hard to compare over time. ## Core Features & Use Cases - GQM-Based Assessment: Applies a Goal-Question-Metric catalog covering eight principles including Single Responsibility, Deep Modules, and Single Knowledge Owner, with concrete default measures for each. - Calibrated Scoring: Scores each principle from 0 to 3 with separate confidence levels, computes an overall score and evidence coverage, and applies a default pass/fail gate when requested. - Structured Report: Produces a self-contained Markdown report with an executive summary, scorecard, change-scenario results, prioritized findings, and validation limitations. - Use Case: Before merging a large refactoring PR, run an audit to get an evidence-cited scorecard showing which simplicity principles regressed, with file-and-line citations and ranked remediation recommendations. ## Quick Start Audit the current repository against software-simplicity principles and produce an evidence-cited scorecard report.

Frequently Asked Questions about audit-codebase

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

FAQPage Schema
How do I audit a codebase for maintainability?▼

Define the assessment scope, baseline, and representative change scenarios, then collect evidence from contracts, source structure, version history, and runtime data. Score each simplicity principle from 0 to 3 with cited evidence and produce a structured scorecard report.

How do I measure software design quality in a pull request?▼

Use a diff-type assessment focused on the stated change, measuring principles like Single Responsibility, Single Knowledge Owner, and Valid States and Failures. Cite evidence as path:line references and report measured values beside each score.

Can static metrics like LOC and complexity prove design problems?▼

No. Static metrics such as LOC, method count, complexity, coupling, and cohesion are warning signals, not verdicts. They cannot alone prove a responsibility or design problem and must be combined with structural, historical, and runtime evidence.

What is the pass/fail gate for a simplicity audit?▼

When no project policy exists, the default gate requires no principle scoring 0, Single Responsibility, Single Knowledge Owner, and Valid States and Failures scoring at least 2, an overall score of at least 2.2/3, and evidence coverage of at least 80%.

When should I not compare audit scores across projects?▼

Do not compare raw scores across unrelated projects, since measurements are only meaningful as trends within the same system and comparable scope. Calibrate targets from the first baseline and repository trend instead of treating default thresholds as universal laws.