Skip to content

Repository navigation

11. Name Conventions

Jump to bottom
Kristi Doce edited this page Oct 7, 2026 · 1 revision

Codebase Naming Conventions

This document outlines the standard naming conventions used across the Orbit project repositories to ensure consistency across services, client applications, AI agents, and database schemas.

1. Python Naming Conventions (PEP 8)

For AI agents, data reconciliation pipelines, and backend microservices written in Python, we strictly adhere to PEP 8 Naming Conventions.

Code Element Naming Style Example Notes
Classes PascalCase ClientManager, ReconciliationEngine Capitalize each word.
Functions & Methods snake_case detect_semantic_conflicts() Lowercase with underscores.
Variables snake_case client_email, is_approved Descriptive and concise.
Constants UPPER_SNAKE_CASE MAX_RETRY_ATTEMPTS, PII_MASK_PATTERN Module-level global values.
Modules (Files) snake_case.py conflict_resolver.py, meeting_agent.py Short, lowercase names.
Packages (Folders) lowercase orbit/agents/, orbit/reconciliation/ Avoid underscores if possible.
Internal / Private _single_leading_underscore _validate_source_grounding() Indicates private class/module scope.

2. TypeScript / JavaScript & React Conventions

Used for the Advisor Dashboard, Client Portal, and cross-platform mobile app. We follow the Airbnb JavaScript Style Guide.

Code Element Naming Style Example Notes
React Components PascalCase AdvisorDashboard.tsx, ClientPortal.tsx File name must match main component.
Functions & Hooks camelCase fetchClientState(), useAuditLogs() Custom hooks must start with use.
Variables & Objects camelCase clientProfile, isConflictDetected Avoid single-letter variable names.
Constants UPPER_SNAKE_CASE API_BASE_URL, DEFAULT_TIMEOUT_MS Global immutable constants.
Folders kebab-case client-portal/, task-manager/ All lowercase separated by hyphens.

3. Java Naming Conventions

Used for core enterprise backend microservices and integration gateways. Follows official Oracle Java Code Conventions.

Code Element Naming Style Example Notes
Classes & Interfaces PascalCase ClientService, TaskRepository Interfaces may use prefix I if required.
Methods & Fields camelCase calculateRiskScore(), clientRecord Verbs for methods, nouns for fields.
Constants UPPER_SNAKE_CASE MAX_CONNECTIONS, DEFAULT_CURRENCY static final fields.
Package Names lowercase ca.orbit.advisor.service Reverse domain notation.

4. PostgreSQL Database Conventions (Tentative)

Applies to database tables, columns, indexes, and primary/foreign keys.

Database Element Naming Style Example Notes
Tables plural_snake_case clients, advisor_tasks, meeting_transcripts Plural nouns.
Columns singular_snake_case client_id, created_at, is_approved Singular nouns/adjectives.
Primary Keys id or table_id id or client_id Consistent across all tables.
Foreign Keys singular_table_id client_id References id on clients table.
Indexes idx_table_column idx_clients_email Explicit and searchable prefix.

Standard References

Clone this wiki locally