e41ecfad4c
Include Loyalty/Communication/Sports Center backends and registry updates alongside production nginx and compose wiring. Co-authored-by: Cursor <cursoragent@cursor.com>
3.3 KiB
3.3 KiB
Phase Template
Reusable template for every implementation phase. Copy to docs/<area>-phase-<id>.md or docs/phases/<Area>/ and fill all sections.
Registry-oriented short form also exists at templates/phase-template.md. Prefer this template for AI-driven implementation phases.
Phase: <Title>
| Field | Value |
|---|---|
| Identifier | (e.g. loyalty-7.1) |
| Status | Planned / In Progress / Complete |
| Owner | Platform / TBD |
| Module(s) | |
| Service(s) | |
| Depends On | |
| ADR(s) | |
| Manifest | phase-manifest.yaml |
Objective
One paragraph: measurable outcome of this phase.
Scope
In Scope
Modules
| Module | Change type | Notes |
|---|---|---|
| new / extend |
Models
| Entity | Soft delete | Audit | Tenant | Notes |
|---|---|---|---|---|
| Yes/No | Yes/No | Yes |
Standards: entity-template.md.
Repositories
| Repository | Aggregates | Tenant filter |
|---|---|---|
| Required |
Standards: repository-template.md.
Services
| Service class | Responsibilities |
|---|---|
Standards: service-layer-template.md.
Validators
| Validator | Rules |
|---|---|
Permissions
| Permission | Description |
|---|---|
{service}.{resource}.{action} |
Events
| Event | When |
|---|---|
Standards: event-template.md.
APIs
| Method | Path | Permission |
|---|---|---|
/api/v1/... |
Standards: api-template.md.
Tests
Mandatory categories (mark N/A with reason only if truly not applicable):
- Unit
- Repository
- Service
- Integration / API
- Migration
- Permission
- Security
- Performance (if hot path)
- Tenant Isolation
- Documentation Validation
Standards: testing-template.md.
Documentation
- Phase doc (this file)
- Progress / Next Steps / Roadmap as applicable
- Module Registry / Provider Registry
- Reference (API / events / schema) if public surface changed
- ADR if architectural decision introduced
- Manifests updated
- Handover completed
Standards: documentation-template.md.
Out of Scope
Explicit exclusions (prevent scope creep):
Completion Criteria
- Objective met
- Scope delivered; Out of Scope untouched
- Tests green
- Quality gates passed (quality-gates.md)
- phase-handover.md filled
- No TODO for claimed work
- Development loop completed (development-loop.md)