jean/time-tracker
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: Update project rules to enhance clarity and efficiency in development practices

Browse Source
This commit is contained in:
Jean Jacques Avril 2025-03-11 16:46:07 +00:00
parent e336ff3ba2
commit 728258caa7
1 changed files with 6 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
.clinerules
View File

@ -1,49 +1,39 @@
# TimeTracker Project Rules (v2) # TimeTracker Project Rules (v2)
0. GENERAL
DONT OVERENGINEER.
USE IN LINE REPLACEMENTS IF POSSIBLE.
SOLVE TASKS AS FAST AS POSSIBLE. EACH REQUEST COSTS THE USER MONEY.
1. ARCHITECTURE 1. ARCHITECTURE
- Multi-tenancy enforced via company_id in all DB queries - Multi-tenancy enforced via company_id in all DB queries
- FPGO/FPTS patterns required for service layer implementations
2. CODING PRACTICES 2. CODING PRACTICES
- Type safety enforced (Go 1.21+ generics, TypeScript strict mode) - Type safety enforced (Go 1.21+ generics, TypeScript strict mode)
- Domain types must match across backend (Go) and frontend (TypeScript) - Domain types must match across backend (Go) and frontend (TypeScript)
- All database access through repository interfaces - All database access through repository interfaces
- API handlers must use DTOs for input/output - API handlers must use DTOs for input/output
- Use tygo to generate TypeScript types after modifying Go types - Use tygo to generate TypeScript types after modifying Go types
3. SECURITY 3. SECURITY
- JWT authentication required for all API endpoints - JWT authentication required for all API endpoints
- RBAC implemented in middleware/auth.go - RBAC implemented in middleware/auth.go
- Input validation using github.com/go-playground/validator - Input validation using github.com/go-playground/validator
- No raw SQL - use GORM query builder - No raw SQL - use GORM query builder
4. DOCUMENTATION 4. DOCUMENTATION
- Swagger docs updated with all API changes
- Architecture decisions recorded in docu/ARCHITECTURE.md - Architecture decisions recorded in docu/ARCHITECTURE.md
- Type relationships documented in docu/domain_types.md - Type relationships documented in docu/domain_types.md
5. TESTING 5. TESTING
- 80%+ test coverage for domain logic - 80%+ test coverage for domain logic
- Integration tests for API endpoints - Integration tests for API endpoints
- Model tests in backend/cmd/modeltest - Model tests in backend/cmd/modeltest
6. FRONTEND 6. FRONTEND
- Next.js App Router pattern required - Next.js App Router pattern required
- Server components for data fetching
- Client components must use TanStack Query
- UI state management via Zustand
8. DEVELOPMENT WORKFLOW 8. DEVELOPMENT WORKFLOW
- Makefile commands are only available in the backend folder - Makefile commands are only available in the backend folder
- Common make commands: - Common make commands:
- make generate: Run code generation (tygo, swagger, etc.) - make generate: Run code generation (tygo, swagger, etc.)
- make test: Run all tests - make test: Run all tests
- make build: Build the application - make build: Build the application
- make run: Start the development server
9. CUSTOM RULES 9. CUSTOM RULES
- Add custom rules to .clinerules if: - Add custom rules to .clinerules if:
- Unexpected behavior is encountered - Unexpected behavior is encountered
- Specific conditions require warnings - Specific conditions require warnings
- New patterns emerge that need documentation - New patterns emerge that need documentation
- make run: Start the development server