conventions-review

Enforce MUST/SHOULD/COULD conventions during code reviews and documentation checks.

1|Updated Jan 5, 2023
One-click install
npx skills add https://github.com/riez/dots --skill conventions-review
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: conventions-review
Source: https://github.com/riez/dots/tree/main/.config/agentic/skills/conventions-review
Command: npx skills add https://github.com/riez/dots --skill conventions-review

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill helps teams ensure consistent review standards by identifying and applying project conventions during code reviews and documentation checks.

Core Features & Use Cases

  • Enforces severity-based conventions and structural guidelines across repositories.
  • Use Case: when reviewing new modules, quickly classify findings against MUST/SHOULD/COULD rules and verify structural alignment with repository standards.

Quick Start

Run the conventions-review workflow during a code review to surface deviations from internal conventions.

Frequently Asked Questions about conventions-review

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

FAQPage Schema
How do I enforce project conventions during a code review?▼

To enforce project conventions during a code review, you can run a rule-based evaluation workflow that surfaces deviations from defined MUST, SHOULD, and COULD structural guidelines across your repositories.

What are severity-based conventions for code review standards?▼

Severity-based conventions classify review findings into MUST, SHOULD, and COULD rule categories, allowing teams to prioritize structural alignment and documentation quality checks according to their defined internal standards.

How do I check if new modules align with repository standards?▼

You check module alignment by running a conventions-review workflow that verifies structural guidelines and surfaces deviations, ensuring new modules satisfy frontmatter-driven metadata and internal repository rules.

Can I use frontmatter metadata to evaluate documentation quality?▼

Yes, you can evaluate documentation quality by leveraging frontmatter-driven metadata within a rule-based evaluation process to verify that project documentation satisfies defined structural guidelines and conventions.

What is the best way to surface deviations from internal coding standards?▼

The best way to surface deviations from internal coding standards is applying a guided quick-start workflow that performs rule-based evaluations against your codebase's defined MUST, SHOULD, and COULD conventions.

Do I need predefined structural guidelines to use a conventions review workflow?▼

Yes, you need defined structural guidelines and internal MUST, SHOULD, and COULD rules established in your repositories before running the rule-based evaluation to surface deviations accurately.