Skip to content

Latest commit

 

History

History
11 lines (11 loc) · 1.85 KB

File metadata and controls

11 lines (11 loc) · 1.85 KB
  • When updating existing code, do not add backwards compatibility features.
  • Avoid using "any" types in both back end and front end code, use proper typing.
  • When creating or updating backend code also create and update related tests. If backend code was updated, run tests to ensure they still pass. Adjust tests if they fail and re-run.
  • Do not create "placeholders" or any other types of partial implementations or stubs for "future use", implement features requested only.
  • Do not create features that are not explicitly described in specifications, if there is a gap, include it summary notes after implementing the task. If there is a question regarding the implementation, do not make assumptions, stop and clarify from the user.
  • When creating or modifying features, create/update documentation in /docs-md folder
  • If you need to run npx prisma generate, run npm run db:generate from apps/backend-services - it's a special script that writes models into apps/temporal/src and apps/backend-services/src. Don't forget to run migrations as normal if necessary.
  • Do not include any document-specific implementation, the system is generic and must support arbitrary workloads
  • All backend controllers must have full Swagger/OpenAPI documentation: use specific decorators (@ApiOkResponse, @ApiForbiddenResponse, @ApiUnauthorizedResponse, @ApiConflictResponse, etc.) instead of generic @ApiResponse, create dedicated DTO classes with @ApiProperty decorators for all request/response shapes, and reference those DTOs via the type field in response decorators.
  • To test API directly, use: curl -H "x-api-key: 69OrdcwUk4qrB6Pl336PGsloa0L084HFp7X7aX7sSTY" http://localhost:3002/api/...
  • NEVER read secrets from .env files directly, they should not be leaked into chat, terminal, etc., do not operate with secret values directly, only indirectly through variables.