17 lines
1.3 KiB
Markdown
17 lines
1.3 KiB
Markdown
# notes/ — Development working log
|
|
|
|
Purpose: **planning, scope locks, implementation steps, audit evidence, decisions, and chronological change/fix logs during development**.
|
|
|
|
## When and how to write
|
|
|
|
1. **Before** each change, create/update a dated phase note with baseline SHA, goal, allowed paths, exclusions, expected behavior, security risks, acceptance criteria and status **PLANNED**.
|
|
2. During work, record decisions, files modified, blockers, exact source evidence and any approved scope change; do **not** claim a test passed unless it ran.
|
|
3. After the change, record actual diff/commit references, tests or CI run URLs when available, known limitations, and final status.
|
|
4. Update `project/` (developer truth) and `docs/` (user truth) in the same phase if behavior or usage changes.
|
|
5. Keep notes concise, chronological and traceable to commits; supersede, do not erase, historic outcomes.
|
|
|
|
This folder is **Git-tracked Markdown**, not a runtime log store and **never** a location for secrets, credentials, user information, access tokens, live data or machine-specific confidential output.
|
|
|
|
## Files
|
|
See [MINIFEST.md](MINIFEST.md) for the exact file register. Phase reports use names such as `P05-PLAN.md` and `P05-RESULT.md`. The current governance/setup change is recorded in `DOCS-01.md`.
|