Check Conventions

Convert ALWAYS/NEVER/MUST directives into line-level PASS/FAIL checks.

1|1|Updated Mar 31, 2026

Search Tags:#automation #conventions #static-analysis #lint #code-review #rules #check

Ready to run

npx skills add https://github.com/btabaska/simpler-grants-documentation-automation --skill check-conventions

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: Check Conventions
Source: https://github.com/btabaska/simpler-grants-documentation-automation/tree/main/.cursor/skills/skill-check-conventions
Command: npx skills add https://github.com/btabaska/simpler-grants-documentation-automation --skill check-conventions

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Resolve repository convention violations by translating ALWAYS/NEVER/MUST directives from documentation/rules/.md and .cursor/rules/.mdc into precise, line-numbered checks on target files. This helps PR reviews stay consistent and auditable, reducing human review cycles.

Core Features & Use Cases

Deterministic, rule-driven checks that map directives to concrete lines in the codebase.
Generates PASS/FAIL reports with line numbers and the exact directive text for auditability.
Integrates with PR reviews and quality gates to enforce coding standards before merging.

Quick Start

Install the toolkit and run the check-conventions command on a target file or diff to see immediate feedback.

Frequently Asked Questions about Check Conventions

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

FAQPage Schema

How do I enforce repository coding conventions automatically in a PR review?▼

Enforce repository conventions by translating ALWAYS/NEVER/MUST directives from rules files into line-level checks. The process generates deterministic PASS/FAIL reports with line numbers and directive text to ensure auditable PR reviews.

How does static analysis map documentation rules to specific code lines?▼

Static analysis maps documentation rules by loading directives from documentation/rules/*.md and .cursor/rules/*.mdc files. It then scans tracked code areas to report deterministic PASS/FAIL results with exact line numbers and the matched directive text.

Can I use markdown rules files to check code conventions across my project?▼

Yes, you can check code conventions by loading rules from markdown files in documentation/rules/*.md and .cursor/rules/*.mdc. The tool applies these directives to all tracked code areas to identify violations with precise line numbers.

What is the best way to automate code review for ALWAYS and NEVER directives?▼

Automate code review for directives by converting ALWAYS/NEVER/MUST rules into deterministic, read-only checks. This approach reduces human review cycles by generating line-numbered PASS/FAIL reports integrated directly into PR quality gates.

Does check-conventions work with .cursor rules files for static analysis?▼

Yes, check-conventions works with .cursor rules files by loading directives from .cursor/rules/*.mdc alongside documentation/rules/*.md. It performs static analysis to resolve scope and report line-level convention violations deterministically.

What are the limitations of deterministic convention checks for code review?▼

Deterministic convention checks are limited to rules defined as ALWAYS/NEVER/MUST directives in loaded markdown files. They provide read-only, auditable PASS/FAIL reports based on static analysis without modifying the target code.