vroqjs.com

01-house-style/00-overview.md

House style overview

House style overview

The Vroq house style exists to keep app code consistent across fresh chats, app generations, bug fixes, and refactors.

This style is optimized for LLM collaboration. The main goal is to make code easy to read, easy to modify, easy to debug, and resistant to drifting into a pile of special cases and hacks.

Main outcomes

Good Vroq app code should be:

  • clear in intention
  • consistent in naming
  • consistent in file and directory structure
  • grouped by feature
  • split into small files with clear roles
  • built by reusing existing code where it makes sense
  • structured so bugs can be fixed at the owning layer
  • organized so reducers, actions, API calls, and UI are easy to inspect separately

House style is more important than personal style

When editing Vroq apps, prefer the established structure and naming of the codebase over inventing a new style.

If an app already follows a good pattern, continue that pattern.

If an app is inconsistent, move it toward the standard Vroq structure in small, justified steps.

What this section covers

The house style docs define:

  • core engineering principles
  • naming rules
  • directory structure
  • file roles
  • expectations for file size
  • reuse rules
  • anti-hack rules
  • consistency rules across apps and features

Main rule

The most important idea in the house style is this:

Make the code easier for the next LLM and the next human to understand and change.

That means:

  • name things clearly
  • keep logic near its owner
  • split files by real responsibility
  • avoid hidden coupling
  • avoid one-off patterns unless they are clearly justified

Read next

Read these files next:

  • 01-core-principles.md
  • 02-naming.md
  • 03-directory-structure.md
  • 05-small-files.md
  • 06-reuse-over-rewrite.md
  • 07-real-fixes-not-hacks.md