Vibe Flow Guide.md

 1<!--
 2SPDX-FileCopyrightText: Amolith <amolith@secluded.site>
 3
 4SPDX-License-Identifier: CC0-1.0
 5-->
 6
 7# Vibe Flow Guide
 8
 9## TASK_DIR Location
10
11**TASK_DIR** is the directory where work files related to a task are stored. Usually, we use **TASK_DIR** = `_plans/{TICKET_ID}/` (a sub-directory of the `_plans` folder). If no ticket ID is known, ask the user for it.
12
13- Create TASK_DIR if it doesn't exist
14- Or, list existing files
15
16## File Naming Convention
17
18Format: `{CYCLE_LETTER}{FILE_NUMBER}-{FILE_TYPE}.md`
19
20**Common file types:**
21
22- `spec` - technical specification
23- `plan` - implementation plan  
24- `summary` - implementation summary document
25- `commit` - suggested commit message and changelog entry
26
27**Example structure:**
28
29```text
30_plans/
31├── 123/
32│   ├── A1-spec.md
33│   ├── A2-plan.md
34│   ├── A3-summary.md
35│   └── B1-spec.md
36```
37
38## Notes
39
40- **TICKET_ID** is a unique identifier for the task, often an issue or ticket number.
41- Cycles are identified by a **CYCLE_LETTER** (A, B, C...). The user decides when to start a new one.
42- In a cycle, determine the next **FILE_NUMBER** from existing file names. Every new file must have a bumped file number.
43- Do not bother the user with CYCLE_LETTER or FILE_NUMBER. They are for internal organization. It's up to you to list the files and determine the last CYCLE_LETTER and FILE_NUMBER. Start CYCLE_LETTER with `A` if there is no existing cycle, and FILE_NUMBER with `1`. So you just need to ask for a **ticket ID** if you don't have one.
44- When the user requests a new cycle: bump CYCLE_LETTER and reset FILE_NUMBER.
45- There is no strict sequence of file types in the workflow. Available file types are also flexible; if you need a new one, just create it.