awesome-code-standards

Coding Standards

Apply consistent naming, structure, and patterns so code is readable and maintainable across the team.

When to Activate

• Starting a new project or module
• Refactoring to match team conventions
• Setting up or updating lint/format/type-check rules
• Reviewing code for consistency
• Onboarding: documenting or applying coding conventions
• Enforcing naming, formatting, or structural consistency

Core Principles

1. Readability first — Code is read more than written; clear names and structure beat clever tricks.
2. KISS — Simplest solution that works; avoid over-engineering and premature optimization.
3. DRY — Extract common logic into functions/modules; avoid copy-paste.
4. YAGNI — Don't build for speculative future needs; add complexity when required.
5. Immutability — Prefer const; avoid mutating arguments or shared state; use spread/copy where needed.

Work Process (when applying standards)

1. Discover project conventions — Scan existing code: naming (camelCase vs snake_case), file layout, import style, test patterns. Check for CONTRIBUTING, .eslintrc, .prettierrc, or editorconfig.
2. Identify violations — Compare changed or new code against those conventions and the rules below.
3. Suggest concrete fixes — Rename symbols, extract functions, add types, fix formatting. Prefer one logical edit per suggestion.
4. Document exceptions — If the project has an exception (e.g. "use any here for legacy"), note it rather than "fixing" it without context.

Naming Conventions

Variables and functions

// GOOD: Descriptive, verb-noun for functions
const marketSearchQuery = 'election';
const isUserAuthenticated = true;
async function fetchMarketData(marketId: string) {}
function calculateSimilarity(a: number[], b: number[]) {}

// BAD: Unclear or noun-only for actions
const q = 'election';
const flag = true;
async function market(id: string) {}
function similarity(a, b) {}

Constants