1.1 KiB
1.1 KiB
Project Guide
Core idea
- An empty project’s first feature defines the whole project.
Subsequent features extend that foundation.
Daily flow
- Create or update features under
Docs/features/FR_*/.... - Commit. The pre-commit hook drives the discussion and maintains summaries (within marker blocks).
- Discuss in
Docs/features/.../discussions/*.discussion.mdand end each comment with
VOTE: READYorCHANGESorREJECT.
First run
- After installation, make an initial commit to activate the hook:
git add . git commit -m "chore: initial commit"
Start a new feature (recommended)
- Copy process/templates/feature_request.md to Docs/features/FR_YYYY-MM-DD_/request.md
- Fill in: Intent, Motivation, Constraints, Rough Proposal, Open Questions, Author
- Commit; the system will drive the discussion and generate/maintain summaries automatically.
Notes
- Keep discussions append-only; votes are single-line VOTE: markers.
- Human READY is required at Implementation/Release stages.
- Ramble (ramble.py) is optional; it can extract fields from your free-form notes.