Skip to content

Name Conventions

Giuliano edited this page Nov 5, 2025 · 9 revisions

Branch Naming (applies to all code):

[prefix]/[issue-number]-[hyphen-separated-name]


Backend (Python)

Follow PEP 8 naming conventions: PEP 8 – Style Guide for Python Code

Quick Reference:

Type Naming Convention
Class CapWords
Type Variables CapWords
Function / Method snake_case
Variable snake_case
Constant ALL_CAPS
File / Module snake_case
Package / Folder lowercase

See the specific page for API Design Guidelines.

Simulator (Python)

Follow PEP 8 naming conventions: PEP 8 – Style Guide for Python Code

Quick Reference:

Type Naming Convention
Class CapWords
Type Variables CapWords
Function / Method snake_case
Variable snake_case
Constant ALL_CAPS
File / Module snake_case
Package / Folder lowercase

Clone this wiki locally