| name | code-quality |
| description | SOLID principles, naming, and "No Comments" policy for GitData-BackEnd. |
💎 GitData BackEnd Code Quality
Standardized rules for maintaining a robust NestJS engine.
📏 General Rules
- No Comments: Code must be self-explanatory.
- SOLID: Follow SOLID principles strictly.
- Single Responsibility: Each service/method should do one thing well.
- Type Safety: Use TypeScript and Zod to ensure data integrity across all layers.
is doing. If the code is complex, refactor it or use descriptive variable/function names.
- Exception: Only use comments for complex algorithmic "why" or to document public APIs (JSDoc).
- Descriptive Names: Use intention-revealing names for variables, functions, and classes.
- Small Functions: Functions should do one thing and be small.
- DRY: Don't Repeat Yourself. Abstract common logic.
- Clean Diff: Keep your changes focused and remove any commented-out code before committing.