Code Style Guide

Project coding standards and style guidelines. Always follow these conventions when writing or reviewing code.

OpenHands Updated 1.4k repo stars

File contents

Code Style Guide

Follow these conventions for all code in this project.

Python

  • Use 4 spaces for indentation
  • Maximum line length: 88 characters (Black default)
  • Use type hints for function signatures
  • Prefer f-strings over .format() or % formatting

Naming Conventions

  • Classes: PascalCase
  • Functions/variables: snake_case
  • Constants: UPPER_SNAKE_CASE
  • Private members: _leading_underscore

Documentation

  • All public functions must have docstrings
  • Use Google-style docstrings
  • Include type information in docstrings when not using type hints

OpenHands/software-agent-sdk commit b7c56f3af7

Frequently asked questions

npx get-skill add openhands-software-agent-sdk/code-style-guide