code-style-review

Document coding conventions from configuration files and source code examples.

41|4|Updated May 6, 2026
One-click install
npx skills add https://github.com/markerikson/opencode-config-example --skill code-style-review
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: code-style-review
Source: https://github.com/markerikson/opencode-config-example/tree/main/config/skill/code-style-review
Command: npx skills add https://github.com/markerikson/opencode-config-example --skill code-style-review

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps you quickly understand and document how an existing codebase is written so you can contribute consistently without guessing.

Core Features & Use Cases

  • Evidence-based style documentation: Builds a conventions guide from lint/format config and real code examples, including file-path references.
  • Onboarding and contribution readiness: Helps new contributors learn naming, organization, patterns, imports, testing, tooling, and inconsistencies in a neutral, audit-style tone.
  • Targeted scope control: Focuses on coding conventions for existing projects while steering you away from architecture-level design and greenfield feature planning.

Quick Start

Use code-style-review for an unfamiliar project to produce a dated Code Style document in the dev-plans repository that summarizes naming, organization, patterns, do’s and don’ts, and observed inconsistencies with evidence from the codebase.

Frequently Asked Questions about code-style-review

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

FAQPage Schema
How do I document coding conventions for an existing codebase?

To document coding conventions, analyze lint and format configurations alongside representative source and test code. This produces a dated style document with concrete file-path references, summarizing naming, organization, and observed inconsistencies.

What's the best way to understand established code patterns for onboarding?

Understand established code patterns for onboarding by reviewing configuration files and representative code samples. This creates an audit-style reference document detailing naming, imports, testing, and observed inconsistencies for new contributors.

Can I use code style analysis for new feature design and architecture planning?

No, code style analysis focuses strictly on capturing existing coding conventions, naming, and organization for current projects. It explicitly steers away from architecture-level design and greenfield feature planning.

How do you capture coding conventions from configuration files?

Capture coding conventions from configuration files by parsing lint and format rules and cross-referencing them with actual source code. This builds an evidence-based style guide with concrete file-path references for team reference.

Does repository analysis include identifying code inconsistencies?

Yes, repository analysis identifies code inconsistencies by evaluating representative source code against lint and format configurations. The resulting style document explicitly highlights observed inconsistencies using an example-driven, audit-style template.