Skip to content

Latest commit

 

History

History
29 lines (22 loc) · 1.03 KB

File metadata and controls

29 lines (22 loc) · 1.03 KB

Rules

Engineering standards: the conventions code in this repository is expected to follow.

Conventions

  • Shared, language-agnostic standards live in common/.
  • Language and framework standards live in rules/<language>/ and rules/<framework>/; add a folder only when it is actively used.
  • One topic per file, kebab-case, written as actionable rules rather than advice.
  • A narrower rule overrides a broader one; say so explicitly where it does.

Topics

Topic File
Coding Style common/coding-style.md
Git Workflow common/git-workflow.md
Patterns common/patterns.md
Security common/security.md
Testing common/testing.md
Component Sourcing react/component-sourcing.md

When to read

Before writing or reviewing code — start with common/, then the language or framework folder that applies.