Gå till innehållet

Naming Conventions

Namngivningskonventioner för Samhalls IT-plattform.

Status: Draft

Datum: 2026-01-13


Repositories

  • Använd lowercase med bindestreck: crm-system, user-service
  • Undvik förkortningar om de inte är allmänt kända
  • Ange typ om relevant: api-gateway, webapp-portal

Databaser

  • Använd lowercase med understreck: crm_production, user_data
  • Prefix med domän vid behov: sales_crm, hr_employees

API Endpoints

  • RESTful naming: /users, /orders, /customers
  • Versioning: /v1/users, /v2/orders
  • Kebab-case för sammansatta ord: /order-items

Kubernetes Resources

  • Lowercase med bindestreck
  • Include environment: crm-api-prod, user-service-dev
  • Max 63 tecken

Variabler och kod

Följ språkets konventioner:

  • TypeScript/JavaScript: camelCase för variabler, PascalCase för klasser
  • Python: snake_case för variabler och funktioner
  • C#: PascalCase för publika medlemmar, camelCase för privata

Filer och mappar

  • Lowercase med bindestreck: user-service.ts, order-controller.py
  • Undvik mellanslag och specialtecken

Detta är en levande standard som uppdateras vid behov.