Skip to content

Commit 05e5652

Browse files
committed
chore: develop
1 parent e5cda8d commit 05e5652

File tree

2 files changed

+39
-38
lines changed

2 files changed

+39
-38
lines changed

.github/workflows/todo.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ jobs:
3131
report: true
3232

3333
- name: Upload TODO report
34-
uses: actions/upload-artifact@v3
34+
uses: actions/upload-artifact@v4
3535
with:
3636
name: todo-report
3737
path: TODO_REPORT.md

ROADMAP.md

Lines changed: 38 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,71 +1,72 @@
11
# 🗺️ Roadmap — `smart-todo-action`
22

3-
A smart GitHub Action that detects, classifies, and transforms inline TODOs in your codebase into actionable GitHub Issues — with semantic analysis and integration with task management systems.
3+
A smart GitHub Action that detects, classifies, and transforms inline TODOs into actionable GitHub Issues — enriched with semantic analysis, metadata extraction, and automated reporting.
44

55
---
66

7-
## 🧱 Phase 1: Foundations & Core Features
7+
## 🧱 Phase 1: Core Foundations
88

9-
> Rebuild the original functionality with clean, modular, and testable code.
9+
> Build a clean, modular, and testable baseline — feature parity with the original idea.
1010
11-
- [X] Project structure and folder setup (`src/`, `core/`, `parser/`, etc.)
12-
- [X] TODO/FIXME/BUG parser with multi-language support
13-
- [ ] Initial task system: GitHub Issues integration
14-
- [ ] Configurable issue templates
15-
- [ ] GitHub Action integration (`action.yml`, workflow example)
16-
- [ ] Unit tests with Vitest or Jest
11+
- [x] Project structure (`src/`, `core/`, `parser/`, `templates/`, etc.)
12+
- [x] Multi-language TODO/FIXME/BUG parser
13+
- [x] Frontmatter metadata support (`priority=high`, `due=2025-06-01`)
14+
- [x] GitHub Issues integration with deduplication
15+
- [x] Configurable issue templates (`title`, `body`)
16+
- [x] GitHub Action entrypoint (`action.yml`, `workflow.yml`)
17+
- [x] CI-ready unit tests with Vitest
1718

1819
---
1920

20-
## 🧠 Phase 2: Intelligence & Semantics
21+
## 🧠 Phase 2: Semantic Intelligence
2122

22-
> Bring context-awareness and automation through LLMs and structured tags.
23+
> Automatically extract meaning and context from TODOs using heuristics and LLMs.
2324
24-
- [ ] Automatic classification (`bug`, `refactor`, `enhancement`, etc.)
25-
- [ ] LLM-powered title/description generation
26-
_e.g., `Review sort algorithm``Optimize Sorting Algorithm for Edge Cases`_
27-
- [ ] Parse structured metadata: `priority`, `due`, etc.
28-
_e.g., `TODO(priority=high, due=2025-06-01): improve this logic`_
29-
- [ ] Support for structured tags (`@assignee`, `#module`, etc.)
25+
- [x] Heuristic label classification (`refactor`, `bug`, `test`, `doc`, etc.)
26+
- [ ] LLM-powered title/body generation
27+
_e.g., `Improve sort``Optimize Sorting Algorithm for Edge Cases`_
28+
- [x] Enhanced metadata parsing (`@assignee`, `#module`, etc.)
29+
- [x] Semantic label fallback when tag is ambiguous
3030

3131
---
3232

33-
## 🌍 Phase 3: Extended Support
33+
## 🌍 Phase 3: Ecosystem Support
3434

35-
> Make the system flexible, extensible, and applicable to diverse environments.
35+
> Expand support to other tools, file types, and languages.
3636
37-
- [ ] Multi-platform task integration (GitHub, Jira, Notion, Trello, Linear)
38-
- [ ] Internationalization (i18n): multilingual TODO detection
39-
- [ ] File format support: `.ipynb`, `.yaml`, `.json`, `.xml`, etc.
37+
- [ ] Task sync with platforms: Jira, Notion, Trello, Linear
38+
- [ ] Multilingual detection (i18n-ready)
39+
- [ ] Parse formats beyond code: `.ipynb`, `.yaml`, `.json`, `.xml`, etc.
4040

4141
---
4242

43-
## 📊 Phase 4: Insights & Reporting
43+
## 📊 Phase 4: Reporting & Insights
4444

45-
> Provide visibility into the evolution and structure of tracked TODOs.
45+
> Provide visibility into TODO usage and evolution.
4646
47-
- [X] Markdown/HTML dashboard with summary statistics
48-
_Total TODOs, grouped by folder, priority, author (`git blame`) — **now sorted by `priority` and `due` date**_
49-
50-
- [ ] TODO history tracking (added/removed/modified)
51-
- [ ] Due date notifications or PR comments
47+
- [x] Markdown dashboard (`TODO_REPORT.md`)
48+
- Group by `priority`, `due`, `semantic label`, and `folder`
49+
- [x] Changelog generation from grouped TODOs (`CHANGELOG.md`)
50+
- [ ] TODO lifecycle tracking (added/removed/changed)
51+
- [ ] Due date notifications (PR comments, issues, or Slack)
5252

5353
---
5454

55-
## 🔁 Phase 5: Optimization & Distribution
55+
## 🔁 Phase 5: Performance & Distribution
5656

57-
> Final touches to ensure performance, scalability, and community usability.
57+
> Make it fast, reliable, and easy to adopt across the community.
5858
59-
- [ ] Plugin-based architecture
60-
- [ ] CLI support (standalone usage outside GitHub Actions)
59+
- [ ] Plugin-based architecture (LLM integration, reporters, etc.)
60+
- [ ] CLI mode (run locally or in CI/CD)
6161
- [ ] >90% test coverage
62-
- [ ] Full documentation with usage examples
62+
- [ ] Full documentation & usage guides
6363
- [ ] Publish to GitHub Marketplace
6464

6565
---
6666

6767
## 📌 Notes
6868

69-
- Clean architecture and modularity are core principles from day one.
70-
- LLM functionality will be optional and clearly separated from core logic.
71-
- Built with automation, extensibility, and developer workflows in mind.
69+
- Built with extensibility and automation in mind.
70+
- LLM functionality is **optional** and kept separate from core logic.
71+
- Designed for teams who want visibility, traceability, and productivity with minimal friction.
72+

0 commit comments

Comments
 (0)