conventions-code-quality

Assesses code quality by applying eight convention documents to identify deviations from standards.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

The Conventions-Code-Quality skill provides a structured, reusable framework to assess and enforce coding standards during reviews, improving consistency and maintainability across projects.

Core Features & Use Cases

  • A library of 8 convention documents governing naming, structure, patterns, documentation, tests, dependencies, cross-file consistency, and project-specific patterns to guide code reviews.
  • On-demand reading of relevant docs to support code-quality assessments during reviews, refactoring, or audits.
  • Use Case: A reviewer applies the applicable conventions to a PR to quickly identify deviations and recommended improvements.

Quick Start

Provide the relevant convention document to guide your next code review.

Frequently Asked Questions about conventions-code-quality

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

FAQPage Schema
How do I evaluate code quality across a project during a code review?

To evaluate code quality during a review, apply a structured framework that identifies deviations from established standards. It assesses naming, structure, patterns, documentation, tests, and dependencies to improve maintainability.

What is a code quality convention framework and how does it work?

A code quality convention framework is a library of documents governing naming, structure, patterns, and dependencies. It works by reading these documents on-demand to support quality assessments, refactoring, and audits.

How do I prioritize code review findings for refactoring?

Prioritize code review findings for refactoring by applying severity definitions from a dedicated conventions file. This ranks deviations based on their impact on project standards and maintainability.

Does this code review framework require specific convention documents to function?

Yes, the code review framework requires on-demand access to eight convention documents stored locally. These files cover naming, structure, patterns, documentation, tests, dependencies, cross-file consistency, and project-specific rules.

What's the best way to audit cross-file consistency in a software project?

The best way to audit cross-file consistency is to use a code-quality evaluation framework that checks deviations against established conventions. This ensures structural alignment and pattern uniformity across the entire project.