convention-check

Detect project convention violations and report them with guidance.

1|1|Updated Apr 9, 2026
Ready to run
npx skills add https://github.com/kangmomin/harness-plugins --skill convention-check
πŸ’¬ Prompt for ChatGPT / Claude Chatβ–Ό
Please help me install this Agent Skill.
Skill: convention-check
Source: https://github.com/kangmomin/harness-plugins/tree/main/be-harness/skills/convention-check
Command: npx skills add https://github.com/kangmomin/harness-plugins --skill convention-check

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

이 μŠ€ν‚¬μ€ μ €μž₯μ†Œμ˜ ν”„λ‘œμ νŠΈ μ»¨λ²€μ…˜ μœ„λ°° 사항을 μžλ™μœΌλ‘œ μ‹λ³„ν•˜κ³  λ³΄κ³ ν•©λ‹ˆλ‹€.

Core Features & Use Cases

  • ν”„λ‘œμ νŠΈ 둜컬 κ·œμΉ™κ³Ό CLAUDE.md의 μ»¨λ²€μ…˜μ„ 비ꡐ해 μœ„λ°˜μ„ νƒμ§€ν•©λ‹ˆλ‹€.
  • .convention-check.json ꡬ성을 톡해 적용 κ·œμΉ™μ„ κ΄€λ¦¬ν•˜κ³ , OVERRIDES.mdλ₯Ό μ‚¬μš©ν•΄ μ˜ˆμ™Έλ₯Ό λ°˜μ˜ν•©λ‹ˆλ‹€.
  • νŒ€μ˜ μ½”λ“œ ν’ˆμ§ˆ κ°€μ΄λ“œλΌμΈ μ€€μˆ˜λ₯Ό μžλ™ν™”ν•˜κ³  개발 속도λ₯Ό λ†’μž…λ‹ˆλ‹€.

Quick Start

Scan the repository for convention violations and generate a report.

Frequently Asked Questions about convention-check

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

FAQPage Schema
How do I automate project convention checks in a repository?β–Ό

To automate project convention checks, configure a `.convention-check.json` file to define rules and use OVERRIDES.md for exceptions. The tool scans the repository, compares code against CLAUDE.md standards, and reports violations with clear guidance.

What is the best way to enforce coding and architectural conventions across plugin projects?β–Ό

Enforcing coding and architectural conventions across plugin projects is done by validating configuration files and applying local overrides. The scanner reads project standards from CLAUDE.md and reports deviations automatically.

How does static analysis for project conventions handle local rule exceptions?β–Ό

Static analysis for project conventions handles local rule exceptions through an OVERRIDES.md file. You define specific exceptions there, and the checker applies these overrides alongside the `.convention-check.json` configuration during the repository scan.

Can I use this convention checker without setting up a CLAUDE.md file?β–Ό

You cannot effectively use this convention checker without a CLAUDE.md file, as it serves as the primary source for project standards. The tool relies on comparing local repository rules against these defined standards to identify and report violations.

Why does my project convention validation report false positives?β–Ό

Project convention validation may report false positives if local exceptions are not properly defined. Ensure your specific use cases are documented in OVERRIDES.md and your `.convention-check.json` configuration accurately reflects your intended coding guidelines.

Do I need to configure specific files before scanning for code quality violations?β–Ό

You need to configure a `.convention-check.json` file to manage applied rules before scanning for code quality violations. This file works with CLAUDE.md standards and OVERRIDES.md to ensure the automated validation matches your project requirements.