Development Rules & Conventions

General Standards

Code style like senior developer

File Naming

• Controllers: Use camelCase (e.g.,kafkaController.ts,userController.ts).
• Services: Use camelCase (e.g.,kafkaService.ts,userService.ts) or PascalCase depending on export type. Class-based services should generally match class name.
• Routes: Use camelCase (e.g.,userRoutes.ts,kafkaRoutes.ts).
• Utilities: Use camelCase (e.g.,httpCodes.ts).

Code Style

• Status Codes: ALWAYS useHTTP_STATUSconstants from@/utils/httpCodes(TS) or../../utils/httpCodes.js(JS) instead of hardcoded numbers.
  • Good:res.status(HTTP_STATUS.OK).json(...)- Bad:res.status(200).json(...)- Imports:
  • TypeScript: Use path aliases (e.g.,@/services/...,@/utils/...) instead of relative paths (e.g.,../../utils/...).
  • JavaScript: Use relative paths as configured by the project structure.

API Response Structure

• Success:{ status: string, data: any }or direct JSON object.
• Error:{ error: string }### Apply unit test
• Apply unit test for each layer
• Apply unit test for each usecase

Git Workflow

• Commit messages should be descriptive.
• Ensure all tests pass before pushing.

Verify function before commit

• npm run test:e2e

Verify case sensitivity before commit