Skip to content

audit-pr now emphasizes DRY and SOLID principles more strictly - #601

Merged
AlexJSully merged 2 commits into
mainfrom
alexjsully-260907-audit-pr
Sep 8, 2026
Merged

audit-pr now emphasizes DRY and SOLID principles more strictly #601
AlexJSully merged 2 commits into
mainfrom
alexjsully-260907-audit-pr

Conversation

@AlexJSully

@AlexJSully AlexJSully commented Sep 7, 2026

Copy link
Copy Markdown
Owner

The audit-pr and audit-quality audits now measure DRY and SOLID violations rather than asking about them, and the reuse lookup covers the ecosystems this codebase actually uses.

  • A sixth structural count splits a function's parameters into those supplying data and those switching behaviour, so control coupling is caught by a number rather than by noticing.
  • Findings carry Measured, Looked up, and Principle fields, which make a skipped lookup visible and name the defect instead of asking for a refactor.
  • The reuse lookup reads the lockfile beside the manifest, resolves imports the language supplies implicitly, and checks a block against the exported surface of a module its own file already imports.
  • A new bundled reference, reuse-and-decomposition.md, carries the manifest and lockfile pair for 21 ecosystems, where each writes down a package's public surface, and the concrete shape of each fix.

Scope beyond audit-pr. audit-quality (both halves), the TypeScript standards skill, copilot-instructions.md, code-style.md, and CLAUDE.md change too. That is the mirror this repository's conventions require, not separate work: copilot-instructions.md is the surface automated reviews read, and a paired audit's two halves must carry the same hard rules. Splitting them would land a rule in one surface and not its mirror.

@AlexJSully
AlexJSully requested a lite review from Copilot September 7, 2026 23:15
@AlexJSully AlexJSully self-assigned this Sep 7, 2026
@vercel

vercel Bot commented Sep 7, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
portfolio Ready Ready Preview Sep 8, 2026 12:17am UTC

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

The changes are limited to review/audit documentation and skill content, with only a minor PR-description scope mismatch called out.

Pull request overview

This PR updates the repository’s review/audit guidance (not production code) to enforce DRY/SOLID-oriented maintainability checks more explicitly, especially around counting structural complexity (including behaviour-switching parameters) and performing “reuse lookups” against existing modules, manifests, and lockfiles.

Changes:

  • Expands the structural measurement model from 5 → 6 counts by adding a parameter split (data vs behaviour switches) and ties findings to named coupling/SOLID/DRY defects.
  • Strengthens “reuse before writing” guidance by explicitly including lockfile-backed resolution and checking imported modules’ exported surfaces.
  • Adds/updates supporting audit-pr reference material and templates so findings can include Measured, Looked up, and Principle evidence fields.
File summaries
File Description
CLAUDE.md Updates documentation to reflect “six structural counts” in the TypeScript standards skill description.
.github/prompts/audit-quality.prompt.md Strengthens reuse-lookup and maintainability/DRY/SOLID framing in the audit-quality prompt (adds 6th count, named coupling defects).
.github/prompts/audit-pr.prompt.md Strengthens audit-pr prompt with reuse-lookup expectations, explicit coupling/DRY defects, and the 6th structural count.
.github/copilot-instructions.md Updates repo-wide Copilot guidance to include the 6th structural count and expanded reuse lookup.
.claude/skills/typescript-code-and-test-standards/SKILL.md Updates skill description and “Structure” guidance to include parameter-count/switch counting and lockfile-aware reuse lookup.
.claude/skills/audit-quality/SKILL.md Mirrors the audit-quality prompt changes in the audit-quality skill (6th count + named coupling/DRY defects + reuse lookup framing).
.claude/skills/audit-pr/SKILL.md Updates the audit-pr skill with the 6th count, stronger DRY/SOLID framing, and a new bundled reuse/decomposition reference.
.claude/skills/audit-pr/references/reuse-and-decomposition.md Adds a new reference detailing lockfile-first reuse checks and decomposition patterns (control coupling, SRP, etc.).
.claude/skills/audit-pr/assets/review-summary.template.md Extends the review template to support “Measured / Looked up / Principle” fields and adds worked examples.
.claude/skills/audit-pr/agents/finding-refuter.md Extends the refutation procedure to re-check the new signature/parameter split evidence.
.claude/rules/code-style.md Updates code-style rules to include the “behaviour-switching parameter” count and strengthened reuse lookup guidance.
Review details
  • Files reviewed: 11/11 changed files
  • Comments generated: 1
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread .github/prompts/audit-quality.prompt.md
@AlexJSully
AlexJSully merged commit bd6d503 into main Sep 8, 2026
2 checks passed
@AlexJSully
AlexJSully deleted the alexjsully-260907-audit-pr branch September 8, 2026 00:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants