CascadingDev/assets/templates/USER_GUIDE.md

24 lines
807 B
Markdown

# Project Guide (CascadingDev)
## Daily flow
1. Work under `Docs/features/FR_*/...`
2. Commit; the pre-commit hook ensures `*.discussion.sum.md` and (later) updates summaries/diagrams.
3. Use `Docs/features/.../discussions/*.discussion.md` for stage talks.
End each comment with `VOTE: READY|CHANGES|REJECT`.
## Start a new feature
- Create `Docs/features/FR_YYYY-MM-DD_<slug>/request.md` from the template.
- Commit; the system seeds stage discussions and summaries automatically.
## First run
- After installation, make an initial commit to activate the hook:
```bash
git add .
git commit -m "chore: initial commit"
```
## Notes
- Keep discussions append-only.
- Human READY is required at Implementation/Release.
- Ramble GUI (`ramble.py`) is optional; use it to seed the first feature.