Skip to content

Latest commit

 

History

History
33 lines (21 loc) · 1.52 KB

CONTRIBUTING.md

File metadata and controls

33 lines (21 loc) · 1.52 KB

Contributing to GlobalTagsAPI

You can read about contributing to the GlobalTagsAPI here!

Naming Conventions

Previously, this project did not enforce strict conventions, which may have resulted in some inconsistencies across the codebase, such as variations in naming styles or file organization. While we are now adopting these standardized conventions to maintain consistency and improve readability, you may still encounter older patterns that deviate from the new guidelines.

  • Translations: Use snake_case for all keys in translation files. Example: welcome_message, error_invalid_input.

  • Database Keys: Always follow snake_case for all keys in the database. Example: user_id, created_at.

  • JSON Body Keys: Use snake_case for all keys in request or response bodies. Example: expires_at, created_at

  • Database Enum Values: Use snake_case for database enum values. Example: admin, regular_user.

  • TypeScript Enum Values: Use PascalCase for enum values. Example: enum Role { Admin, User, Guest }.

  • TypeScript Classes: Use PascalCase for class names. Example: UserManager, ApiService.

  • Normal TypeScript Files: Use kebab-case for file names. Example: user-manager.ts, api-service.ts.

Time Handling in the Database

  • Always use mongodb date strings for time-related fields in the database instead of numeric timestamps. Example: "2025-01-09T12:34:56Z" instead of 1673262896.