| name | step-workflow |
| description | Use when the user requests step-based file naming and folder organization for a new feature, including sequential numbered prefixes, sub-step notation, and plan tracking across scripts, outputs, tests, or documentation. |
Step-Based Workflow Organization
Overview
Organize all work for a feature using step-based file naming with numbered
prefixes. Apply this convention only when the user requests it and it does not
conflict with an established repository layout or naming convention.
File Naming Convention
Basic Pattern
<step_number>_<descriptive_name>.<extension>
Examples:
01_load_data.py02_clean_data.py03_analysis.ipynb04_results.csv
Sub-Steps
When a step has multiple related files:
<step>_<substep>_<descriptive_name>.<extension>
Examples:
01_1_fetch_api.py01_2_parse_response.py02_1_clean_text.py02_2_clean_numbers.py
Leading Zeros
Use leading zeros based on the expected number of steps:
- 10–99 steps:
01, 02, ..., 99
- 100–999 steps:
001, 002, ..., 999
This ensures proper alphabetical sorting.
Workflow Rules
- Respect repository conventions - Apply step-based names only when the
user requests them and they do not conflict with established project layout
- Keep related artifacts together - Keep files for the feature in its
feature folder while preserving the repository's expected subdirectories
- Number files sequentially - Order prefixes by execution or workflow
- Use underscores, not spaces - Keep file names shell- and tool-friendly
- Track the numbered work with
update_plan - Map each plan item to its
corresponding step, keep at most one item in progress, and leave none in
progress after completion
- Renumber when needed - Restore a clear sequence after inserting or
reordering steps
Plan Integration
Each plan item corresponds to a numbered step:
1. [in_progress] Load data (01_load_data.py)
2. [pending] Clean data (02_clean_data.py)
3. [pending] Run analysis (03_analysis.py)
Use update_plan as the work advances so file order and task state remain
aligned.
