Remove markdown test docs and document tests inline
This commit is contained in:
@@ -9,7 +9,6 @@ This file applies to the entire repository.
|
||||
Before starting substantial work, read the source-of-truth docs that match the task:
|
||||
|
||||
- implementation and repository-structure work: [docs/architecture.md](/home/kurihada/project/ai-workflow-skill/docs/architecture.md), [docs/skill-workspace-monorepo.md](/home/kurihada/project/ai-workflow-skill/docs/skill-workspace-monorepo.md)
|
||||
- inbox Markdown test-plan work: [docs/tests/inbox/ROADMAP.md](/home/kurihada/project/ai-workflow-skill/docs/tests/inbox/ROADMAP.md)
|
||||
|
||||
## Documentation Update Rule
|
||||
|
||||
@@ -20,18 +19,15 @@ Do not finish a task and leave its documentation stale.
|
||||
Required behavior:
|
||||
|
||||
- if you complete or materially change implementation behavior, architecture, runtime ownership, or product structure, update the relevant source-of-truth docs in the same change
|
||||
- if you add, remove, or materially revise inbox Markdown test cases or test-plan documents, update [docs/tests/inbox/ROADMAP.md](/home/kurihada/project/ai-workflow-skill/docs/tests/inbox/ROADMAP.md) in the same change
|
||||
- when a test-plan document is created, update document progress
|
||||
- when a test case is written, update authored-case tracking and pending backlog
|
||||
- when a planned item is no longer needed, mark it as removed or deferred instead of silently dropping it
|
||||
- if you materially change automated test coverage or test structure, keep the relevant source files and repository docs consistent in the same change
|
||||
|
||||
## Inbox Test-Plan Specific Rule
|
||||
## Test Documentation Rule
|
||||
|
||||
For `docs/tests/inbox/`:
|
||||
For automated tests in this repository:
|
||||
|
||||
- organize by folder plus `README.md`
|
||||
- do not use numeric test IDs
|
||||
- use stable case slugs and keep the roadmap synchronized with the actual files on disk
|
||||
- do not create or maintain standalone Markdown test-plan documents under `docs/tests/`
|
||||
- keep test intent close to the executable test by adding a short comment above each top-level `Test...` function
|
||||
- keep test comments concise and focused on the behavior or contract the test is protecting
|
||||
|
||||
## Project Skills
|
||||
|
||||
|
||||
Reference in New Issue
Block a user