check-patterns

Check repository code against documented conventions and produce PASS/WARN/FAIL findings.

4|1|Updated Dec 7, 2025
One-click install
npx skills add https://github.com/cacack/my-family --skill check-patterns
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: check-patterns
Source: https://github.com/cacack/my-family/tree/main/.claude/skills/check-patterns
Command: npx skills add https://github.com/cacack/my-family --skill check-patterns

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps a reviewer verify that repository code adheres to the project's documented conventions in docs/CONVENTIONS.md by spot-checking patterns across backend, API, event, and frontend code while remaining read-only.

Core Features & Use Cases

  • Error handling checks: Spot-check Go files to see whether errors are wrapped with context (fmt.Errorf with %w) or returned as bare errors.
  • Naming and command patterns: Inspect command/*.go filenames and exported types for CreateX/UpdateX/DeleteX handler naming conventions.
  • API and OpenAPI validation: Review internal/api/openapi.yaml for plural collection nouns and appropriate HTTP method usage.
  • Event factory and frontend checks: Verify event constructors call NewBaseEvent() and that Svelte component filenames use PascalCase.
  • Use Case: A tech lead runs this Skill on recent commits to produce PASS/WARN/FAIL outcomes with file-level examples and remediation notes.

Quick Start

Use the check-patterns skill to audit the repository against docs/CONVENTIONS.md and return a PASS/WARN/FAIL report with specific file examples and explanations.

Frequently Asked Questions about check-patterns

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

FAQPage Schema
How do I verify repository code follows established conventions in Go and Svelte?

To verify code follows established conventions, spot-check recent Go and Svelte files against docs/CONVENTIONS.md, evaluating error wrapping, naming patterns, and component filenames to produce PASS/WARN/FAIL findings with file examples.

How does checking OpenAPI specs for conventions work?

Checking OpenAPI specs involves reviewing internal/api/openapi.yaml to ensure plural collection nouns and appropriate HTTP method usage, validating the API design against documented conventions and returning specific rationale for any deviations found.

Can I audit Go error handling patterns for fmt.Errorf %w wrapping?

You can audit Go error handling patterns by spot-checking Go files to determine whether errors are wrapped with context using fmt.Errorf with %w or returned as bare errors, generating a report with concrete file examples.

Does this convention checking require write access to the repository?

Convention checking does not require write access; it operates with read-only access to repository files and docs/CONVENTIONS.md, sampling recent files to safely produce PASS/WARN/FAIL outcomes without modifying code.

What is the best way to check Svelte component naming and event factory usage?

The best way to check Svelte component naming and event factory usage is to verify Svelte filenames use PascalCase and ensure event constructors call NewBaseEvent(), returning findings with specific file examples and remediation notes.

Why does my code review miss CreateX UpdateX DeleteX handler naming conventions?

Code reviews miss CreateX UpdateX DeleteX handler naming conventions when command/*.go filenames and exported types are not spot-checked against docs/CONVENTIONS.md, which this process addresses by sampling recent files and reporting deviations.