mirror of
https://github.com/affaan-m/ECC.git
synced 2026-08-25 17:02:25 +02:00
41599069c3
* fix(steering): add missing name attribute to auto-inclusion steering files * docs: include name attribute on steering file example --------- Co-authored-by: Jucelio Brandao Goncalves Junior <jbgjunior@simpress.com.br>
1.2 KiB
1.2 KiB
inclusion, name, description
| inclusion | name | description |
|---|---|---|
| auto | patterns | Common design patterns including repository pattern, API response format, and skeleton project approach |
Common Patterns
Skeleton Projects
When implementing new functionality:
- Search for battle-tested skeleton projects
- Use parallel agents to evaluate options:
- Security assessment
- Extensibility analysis
- Relevance scoring
- Implementation planning
- Clone best match as foundation
- Iterate within proven structure
Design Patterns
Repository Pattern
Encapsulate data access behind a consistent interface:
- Define standard operations: findAll, findById, create, update, delete
- Concrete implementations handle storage details (database, API, file, etc.)
- Business logic depends on the abstract interface, not the storage mechanism
- Enables easy swapping of data sources and simplifies testing with mocks
API Response Format
Use a consistent envelope for all API responses:
- Include a success/status indicator
- Include the data payload (nullable on error)
- Include an error message field (nullable on success)
- Include metadata for paginated responses (total, page, limit)