Code Style

Code Style

Follow these guidelines to ensure code quality and consistency.

Guidelines

• PEP 8 for Python code
• Use type hints
• Write docstrings for all public functions/classes
• Use descriptive variable and function names
• Keep functions small and focused
• Use black and isort for formatting
• Run flake8 for linting

Linting Process

flowchart TD
    A[Write Code] --> B[Run Formatter (black/isort)]
    B --> C[Run Linter (flake8)]
    C --> D[Fix Issues]
    D --> E[Ready for PR]

Loading

Related

• Development
• Contributing
• Testing