clean-code-refiner

Solid

Facilitate a structured conversation to define clean code principles for a repository. Produces a formal clean-code.md document that the clean-code atom will use as its override. Use when setting up coding standards, defining code quality rules, or when the user says 'setup clean code', 'define coding standards', 'code quality principles', 'coding guidelines', or 'help me define my code standards'.

Code & Development 134 stars 8 forks Updated 3 days ago MIT

Install

View on GitHub

Quality Score: 87/100

Stars 20%
71
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Clean Code Refiner ## What This Produces - **Output**: `.lattice/standards/clean-code.md` (or custom path from `.lattice/config.yaml` -> `paths.clean_code`) - **Two modes**: - **Overlay** (`mode: overlay`): A slim document containing only sections that differ from the defaults. The clean-code atom reads its embedded defaults first, then applies this document's sections on top. This is the expected common case. - **Override** (`mode: override`): A comprehensive standalone document that fully replaces the atom's embedded defaults. For teams with fundamentally different coding standards. - **Default mode**: Overlay -- produces only what the user wants to change - **Config key**: `paths.clean_code` in `.lattice/config.yaml` - **Template**: Read `./assets/template.md` for the full document structure, default content, and interview guidance comments ## Scope Clarification This skill defines the *rules of code craftsmanship* -- how individual functions, classes, and modules should be written. It does not define architecture (that is the architecture-refiner) or domain modeling (that is the ddd-refiner). The boundaries: - **Clean code** -- function size, naming, complexity, error handling, testability, abstraction discipline - **Clean architecture** -- layers, dependency direction, command/query flows, structural placement - **DDD** -- aggregates, entities, value objects, domain events, repository patterns ## Before You Begin ### Check for existing documents Before star...

Details

Author
techygarg
Repository
techygarg/lattice
Created
3 months ago
Last Updated
3 days ago
Language
Shell
License
MIT

Related Skills