Naming Conventions

Field Details
Status Active
Last Updated 04-22-2026

Purpose

To maintain proper naming consistency throughout the project

Scope

Applies to: All backend services, frontend applications

Does not apply to: Legacy code, third-party libraries, any project started before 22 April 2026

Variables

  • Use camelCase
  • Be descriptive — no single letters except loop counters (i, j)

Functions & Methods

  • Use camelCase
  • Start with a verb
getUserById(), calculateTotal()

Classes & Interfaces

  • Use PascalCase
  • Classes → nouns, Interfaces → capability words
InvoiceService, Exportable

Constants & Enums

  • Constants → UPPER_SNAKE_CASE
  • Enum type → PascalCase, Enum values → UPPER_SNAKE_CASE
MAX_RETRY_COUNT, PaymentStatus.FAILED

Files & Folders

  • Use kebab-case
user-profile.service.ts, /api-integrations/

Database

  • Tables → snake_case, plural
  • Columns → snake_case
  • Primary key → always id
  • Foreign keys → <table>_id
payment_transactions → id, user_id, created_at

API Endpoints

  • Use kebab-case, lowercase, versioned
GET /v1/users, POST /v1/invoice-items
GET /getUsers, POST /CreateInvoiceItem

Exceptions

No exceptions.

Changelog

Version Date Author Change
1.0.0 04-22-2026 Tibin Sunny Initial version