docs: add development and release standards
This commit is contained in:
1 parent
36a0caecd8
commit
72ad19a071
7 files changed
+458
No files matched your search
@@ -0,0 +1,88 @@
|
||||
# Task NNN: Feature Name
|
||||
|
||||
## Objective
|
||||
|
||||
Describe the operational outcome.
|
||||
|
||||
## Background
|
||||
|
||||
Summarize relevant current behavior and dependencies.
|
||||
|
||||
## Scope
|
||||
|
||||
List exactly what is included.
|
||||
|
||||
## API
|
||||
|
||||
Define every route, request, response, permission, and status code.
|
||||
|
||||
## Permissions
|
||||
|
||||
Define capabilities and role assignments.
|
||||
|
||||
## Domain Rules
|
||||
|
||||
List invariants and lifecycle rules.
|
||||
|
||||
## Architecture
|
||||
|
||||
Preserve:
|
||||
|
||||
```text
|
||||
Router -> Service -> Repository -> PostgreSQL
|
||||
```
|
||||
|
||||
## Database and Migration
|
||||
|
||||
Define schema changes, constraints, indexes, migration order, and downgrade behavior.
|
||||
|
||||
## Events and History
|
||||
|
||||
Define immutable events, sequence, actor, timestamp, and structured payload.
|
||||
|
||||
## Models and Validation
|
||||
|
||||
Define UUID, time, enum, normalization, length, and JSON requirements.
|
||||
|
||||
## Repository Requirements
|
||||
|
||||
Define focused query and locking behavior. Avoid N+1 queries and generic CRUD.
|
||||
|
||||
## Service Requirements
|
||||
|
||||
Define validation, workflow, transaction boundaries, and domain exceptions.
|
||||
|
||||
## Router Requirements
|
||||
|
||||
Define dependencies, exception mapping, and route-count constraints.
|
||||
|
||||
## Error Behaviour
|
||||
|
||||
Define 401, 403, 404, 409, 422, and any additional statuses.
|
||||
|
||||
## Concurrency and Atomicity
|
||||
|
||||
Describe races and database enforcement.
|
||||
|
||||
## Tests
|
||||
|
||||
Cover authorization, domain behavior, rollback, constraints, migrations, regressions, routing, and architecture audits.
|
||||
|
||||
## Validation
|
||||
|
||||
Run compilation, shell validation, focused and regression tests, migration lifecycle tests, disposable baseline, architecture audits, route audit, and `git diff --check`.
|
||||
|
||||
## Documentation
|
||||
|
||||
List required roadmap, release, API, or operator documentation.
|
||||
|
||||
## Explicitly Out of Scope
|
||||
|
||||
List adjacent features that must not be added.
|
||||
|
||||
## Completion Report
|
||||
|
||||
Report files, migration, routes, permissions, tests, validation, limitations, and final `git status --short`.
|
||||
|
||||
Do not commit.
|
||||
Do not push.
|
||||
Reference in new issue
Block a user