Skip to content

Code Style and Standards

Jump to bottom
ohadedry edited this page Oct 22, 2025 · 1 revision

Code Style and Standards

  • Python Style: Follow PEP 8 guidelines and use Black for formatting
  • Type Hints: Include type hints where helpful
  • Documentation: Add docstrings to functions and classes explaining purpose, arguments, return values, and exceptions
  • Naming: Use descriptive variable and function names
  • Comments: Explain 'why' not 'what' in code comments

Table of Contents

Home

Engineering Guidelines

- How to build and run

- Architecture Overview

- Common Flows

- Testing

- Code Style and Standards

Clone this wiki locally