Coding Standards

Coding Standards

Check code against these standards when reviewing or writing.

Naming

• Use clear, descriptive names for variables and functions
• Prefix booleans with is_, has_, can_, should_
• Use UPPER_SNAKE_CASE for constants
• Use PascalCase for classes, snake_case (Python) or camelCase (JS/TS) for functions

Structure

• Keep functions to one responsibility, under 50 lines
• Limit nesting to 3 levels of indentation
• Group related code; separate unrelated code
• Organize imports: stdlib, third-party, local

Error Handling

• Handle errors at the appropriate level — never swallow them
• Write descriptive, actionable error messages
• Clean up resources properly (context managers, try/finally)

Documentation

• Add docstrings/JSDoc to public APIs
• Use inline comments to explain why, not what
• Keep README up to date with setup instructions

For language-specific conventions, see references/python.md or references/typescript.md.