name: Find TODO and FIXME Comments description: Search markdown files, Nextflow scripts, and config files for TODO/FIXME comments, categorize by priority, and provide actionable recommendations. Use when you need to identify pending work or track technical debt.
Find TODO and FIXME Comments
Search the training materials codebase for TODO and FIXME comments to identify pending work.
Execute from repository root. See ../shared/repo-conventions.md for directory structure.
Tasks to Perform
-
Search Markdown Files
- Use Grep to find TODO and FIXME in
docs/**/*.md - Capture file path, line number, and full comment
- Note context (which module/lesson)
- Use Grep to find TODO and FIXME in
-
Search Nextflow Scripts
- Find TODO/FIXME in
**/*.nffiles - Distinguish between training examples and solution code
- Note if in core examples or side-quests
- Find TODO/FIXME in
-
Search Configuration Files
- Check
mkdocs.yml - Check
.github/**/*.ymland.github/**/*.py - Check
CONTRIBUTING.md
- Check
-
Categorize Results
- High Priority: Marked as FIXME, TODO(urgent), or blocking
- Documentation: TODOs in markdown files
- Code: TODOs in .nf or .py files
- Configuration: TODOs in config files
-
Check Known Issues
- Read CONTRIBUTING.md for any documented TODOs
- Note which are tracked vs untracked
Output Format
Provide an organized report:
# TODO/FIXME Report
## Summary
- Total items: 23
- High priority: 3
- Documentation: 15
- Code: 4
- Configuration: 1
## High Priority Items
### docs/hello_nextflow/03_hello_workflow.md:156
```markdown
<!-- FIXME: Update this example for DSL2 syntax -->
Documentation TODOs
By File
docs/side_quests/debugging.md (5 items)
- Line 45: TODO: Add example of common error message
- Line 89: TODO: Include screenshot of trace report
- ...
docs/nf4_science/genomics/01_per_sample_variant_calling.md (3 items)
- Line 234: TODO: Verify this command works with latest GATK
- ...
Code TODOs
nf-training/script7.nf:23
// TODO: Add error handling for missing files
Configuration TODOs
CONTRIBUTING.md:204
Known limitation documented - needs upstream fix in mkdocs plugin
Recommendations
-
Immediate attention (3 items):
- Fix blocking issues in hello_nextflow
- Update genomics examples for latest tools
-
Next sprint (8 items):
- Complete debugging module exercises
- Add missing screenshots
-
Low priority (12 items):
- Style improvements
- Nice-to-have features
Files with Most TODOs
- docs/side_quests/debugging.md (5)
- docs/nf4_science/genomics/01_per_sample_variant_calling.md (3)
- nf-training/script7.nf (2)
## Notes
- Use Grep tool with pattern `TODO|FIXME` (case insensitive)
- Show enough context to understand what needs doing
- Distinguish between legitimate TODOs and example comments in training materials
- Provide actionable priorities, not just a list