Instruction file imported from aamirbohra72/Follett-ReportModule (
.github/instructions/cip-task-workflow.instructions.md). Copyright stays with the author.
CIP Task Workflow — Copilot Instructions
Wiki is the Single Source of Truth
wiki/ holds all project knowledge. Always consult it before acting.
| Folder | Purpose |
|---|---|
wiki/architecture/ |
Architecture docs, diagrams, API contracts, ADRs — read before implementing |
wiki/tasks/todo/ |
Backlog — tasks not yet started |
wiki/tasks/in-progress/ |
Actively worked — keep to 1–3 files max |
wiki/tasks/done/ |
Completed and archived |
Full workflow rules: wiki/tasks/README.md
Before Starting Any Implementation
- Check
wiki/tasks/for a task file matching the work about to be done - If no task file exists → create one in
todo/first - Create a new git branch named after the task:
git checkout -b task/TASK-NNN-kebab-case-title - Move the task file to
in-progress/and record the branch name in the Notes section - Read the relevant
wiki/architecture/doc to understand design intent
After Completing Work
- Move the task file from
in-progress/todone/ - Add completion date and PR/commit reference in the Notes section
- Update the Status Snapshot table in
wiki/tasks/README.md
Task File Rules
- Naming:
TASK-NNN-kebab-case-title.md— sequential numbers, never reused - One task = one logical unit of work (not one file, not one PR)
- Required sections: "What" + at least one Acceptance Criterion
- Never edit
done/files except to correct factual errors - Files are moved, not copied — the filename stays the same throughout its lifecycle
Hard Rules — Always Follow
- DO NOT create new markdown files to document or summarize completed changes unless the user explicitly asks
- DO NOT skip the task check step before implementing — always verify task state first
- DO NOT add architecture insights as task files — update
wiki/architecture/directly - DO NOT copy task files across folders — move them