1.3 KiB
1.3 KiB
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
- 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.
- During work, record decisions, files modified, blockers, exact source evidence and any approved scope change; do not claim a test passed unless it ran.
- After the change, record actual diff/commit references, tests or CI run URLs when available, known limitations, and final status.
- Update
project/(developer truth) anddocs/(user truth) in the same phase if behavior or usage changes. - 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 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.