house-style

Enforces repository writing style rules through automated prose and identifier quality gates.

4|Updated Dec 1, 2025
One-click install
npx skills add https://github.com/simplyblock/simplyblock-operator --skill house-style-simplyblock
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: house-style
Source: https://github.com/simplyblock/simplyblock-operator/tree/main/.claude/skills/house-style
Command: npx skills add https://github.com/simplyblock/simplyblock-operator --skill house-style-simplyblock

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve? Inconsistent spelling, punctuation, and voice across design documents, test plans, and code comments make an engineering repository harder to read and review. This Skill defines the house style (American English, Oxford comma, lowercase simplyblock brand, third-person voice) and provides gate scripts that detect and auto-fix violations in Markdown, Go, Python, and YAML files. ## Core Features & Use Cases - Automated quality gates: Run quality-gate.sh to check American English spelling, punctuation, terminology, brand casing, prose errors, counterfactual phrasing, and identifier naming across the repository or only changed files. - Auto-fix support: Five checks (spelling, terminology, American English, punctuation, prose) rewrite their own findings in place with --fix, while the identifier gate reports renames to be done with refactoring tools. - Code-aware checking: In Go, Python, and YAML files only comments, docstrings, and declared names are checked, skipping code, tool directives, generated files, and vendored trees. - Use Case: Before handing back a change to operator/docs design documents, run the gates with --changed, capture the output to a file, clear every error, and record a verdict for each warning. ## Quick Start Ask the assistant to run the house-style quality gates on the changed files and resolve every reported error and warning.

Frequently Asked Questions about house-style

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

FAQPage Schema
How do I run the house style quality gates on changed files?

Run quality-gate.sh with the --changed flag from the scripts directory to check only what changed versus HEAD, including code files. Capture the full output to a file rather than piping through tail, since warnings never fail the gate and each one needs a decision.

How do I automatically fix spelling and punctuation findings?

Five checks support --fix: check-simplyblock-spelling.py, check-terminology.py, check-american-english.py, check-punctuation.py, and check-prose.py. They rewrite prose occurrences in place, but never touch code blocks, so review the diff afterward.

Does the style check apply to Go, Python, and YAML code?

Yes, but only comments, docstrings, and declared names are checked, not the code itself. The identifiers gate verifies American English and brand casing in function, type, field, and YAML key names across camelCase, snake_case, and PascalCase.

Why does the gate pass even when warnings are reported?

Gates fail only on errors, never on warnings, so the summary line can say all gates passed while warnings remain. Warning-only gates like counterfactual and voice require each finding to be rewritten or explicitly justified.

Can the identifier gate rename misspelled variable names automatically?

No, the identifiers gate has no --fix because renaming a declared name requires updating every reference. Use a refactoring tool like gopls rename, and note that renaming an exported name or CRD field is an API change.

What files are excluded from the house style checks?

Vendored and generated trees, published Helm chart repositories, packaged chart indexes, test-run artifacts, and files with generated-code markers are skipped. The development Helm chart under helm-charts/charts/simplyblock-operator is hand-written source and remains in scope.