Code Style Guide

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

OpenHands b7c56f3 752 B Updated

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/tree/main/examples/05_skills_and_plugins/01_loading_agentskills/example_skills/code-style-guide commit b7c56f3af7

Frequently asked questions

npx skillmds@latest add openhands-software-agent-sdk/code-style-guide