docs: update readme
This commit is contained in:
@@ -189,7 +189,7 @@ When working on this project, follow this workflow:
|
||||
- Implement tests
|
||||
|
||||
### 6. Verify Alignment
|
||||
- Ensure code follows Clean/Hexagonal Architecture principles
|
||||
- Ensure code follows Hexagonal Architecture principles
|
||||
- Verify it aligns with microservices architecture
|
||||
- Check that it follows plugin-first design
|
||||
- Confirm security-by-design principles are followed
|
||||
@@ -210,7 +210,7 @@ When working on this project, follow this workflow:
|
||||
|
||||
The project follows these core principles (documented in `requirements.md` and `playbook.md`):
|
||||
|
||||
1. **Clean/Hexagonal Architecture**
|
||||
1. **Hexagonal Architecture**
|
||||
- Clear separation between `pkg/` (interfaces) and `internal/` (implementations)
|
||||
- Domain code in `internal/domain`
|
||||
- Only interfaces exported from `pkg/`
|
||||
@@ -272,7 +272,7 @@ After implementing a feature, verify:
|
||||
2. **Committing without verification** - Never commit code that doesn't build, has failing tests, or doesn't meet acceptance criteria
|
||||
3. **Implementing without checking stories** - Stories contain specific deliverables and acceptance criteria
|
||||
4. **Ignoring ADRs** - ADRs document why decisions were made; don't reinvent the wheel
|
||||
5. **Violating architecture principles** - Code must follow Clean/Hexagonal Architecture
|
||||
5. **Violating architecture principles** - Code must follow Hexagonal Architecture
|
||||
6. **Missing acceptance criteria** - All stories have specific criteria that must be met
|
||||
7. **Not following module patterns** - Modules must implement the `IModule` interface correctly
|
||||
8. **Skipping observability** - All features must include proper logging, metrics, and tracing
|
||||
|
||||
Reference in New Issue
Block a user