Coding Standards

Coding Standards

Backend Python

Exception Chaining (REQUIRED)

try:
    result = operation()
except ValueError as e:
    raise ValidationError(str(e)) from e  # ALWAYS chain
else:
    return result

Typed Dependencies (REQUIRED)

from backend.api.deps import SessionDep
from backend.auth.deps import CurrentUser
from backend.rbac.deps import OrgContextDep, TeamContextDep

Domain Exceptions (REQUIRED)

# Use these, not HTTPException or ValueError
raise ResourceNotFoundError("Team", team_id)
raise ValidationError("email", "Invalid format")
raise AuthorizationError("Cannot delete")

Timestamps (REQUIRED)

from datetime import UTC, datetime
now = datetime.now(UTC)  # ALWAYS use UTC

Constants (REQUIRED)

MAX_RETRIES = 3  # Use constants, not magic numbers

Frontend TypeScript

i18n (REQUIRED)

const { t } = useTranslation()
<Button>{t("com_save")}</Button>  // NEVER hardcode strings

Path Aliases (REQUIRED)

import { Button } from "@/components/ui/button"  // Use @/ prefix

Error Display (REQUIRED)

{mutation.isError && <ErrorAlert error={mutation.error} />}

Form State (REQUIRED)

form.setValue("field", value, { shouldDirty: true })

Test IDs (REQUIRED)

import { testId } from "@/lib/test-id"

// ALL interactive elements MUST have test IDs
<Button {...testId("feature-submit-button")}
<Input {...testId("feature-name-input")} {...form.register("name")} />
<DialogContent {...testId("confirm-delete-dialog")}>...</DialogContent>

Naming Convention: {component}-{element}-{type} in kebab-case

• Buttons: create-team-submit-button, delete-prompt-confirm-button
• Inputs: login-email-input, settings-name-input
• Dialogs: edit-prompt-dialog, delete-org-alert-dialog
• Lists: document-list, document-item-${id}
• Tables: configured-models-table, model-row-${id}

Converted and distributed by TomeVault — claim your Tome and manage your conversions.