From 05e5652d42099c08f6f5988d58ce03774ccbf191 Mon Sep 17 00:00:00 2001 From: Diogo Ribeiro Date: Thu, 17 Apr 2025 19:47:09 +0100 Subject: [PATCH] chore: develop --- .github/workflows/todo.yml | 2 +- ROADMAP.md | 75 +++++++++++++++++++------------------- 2 files changed, 39 insertions(+), 38 deletions(-) diff --git a/.github/workflows/todo.yml b/.github/workflows/todo.yml index a05c181..bdf55ad 100644 --- a/.github/workflows/todo.yml +++ b/.github/workflows/todo.yml @@ -31,7 +31,7 @@ jobs: report: true - name: Upload TODO report - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: name: todo-report path: TODO_REPORT.md diff --git a/ROADMAP.md b/ROADMAP.md index 78909d5..ffbb75b 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -1,71 +1,72 @@ # πŸ—ΊοΈ Roadmap β€” `smart-todo-action` -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. +A smart GitHub Action that detects, classifies, and transforms inline TODOs into actionable GitHub Issues β€” enriched with semantic analysis, metadata extraction, and automated reporting. --- -## 🧱 Phase 1: Foundations & Core Features +## 🧱 Phase 1: Core Foundations -> Rebuild the original functionality with clean, modular, and testable code. +> Build a clean, modular, and testable baseline β€” feature parity with the original idea. -- [X] Project structure and folder setup (`src/`, `core/`, `parser/`, etc.) -- [X] TODO/FIXME/BUG parser with multi-language support -- [ ] Initial task system: GitHub Issues integration -- [ ] Configurable issue templates -- [ ] GitHub Action integration (`action.yml`, workflow example) -- [ ] Unit tests with Vitest or Jest +- [x] Project structure (`src/`, `core/`, `parser/`, `templates/`, etc.) +- [x] Multi-language TODO/FIXME/BUG parser +- [x] Frontmatter metadata support (`priority=high`, `due=2025-06-01`) +- [x] GitHub Issues integration with deduplication +- [x] Configurable issue templates (`title`, `body`) +- [x] GitHub Action entrypoint (`action.yml`, `workflow.yml`) +- [x] CI-ready unit tests with Vitest --- -## 🧠 Phase 2: Intelligence & Semantics +## 🧠 Phase 2: Semantic Intelligence -> Bring context-awareness and automation through LLMs and structured tags. +> Automatically extract meaning and context from TODOs using heuristics and LLMs. -- [ ] Automatic classification (`bug`, `refactor`, `enhancement`, etc.) -- [ ] LLM-powered title/description generation - _e.g., `Review sort algorithm` β†’ `Optimize Sorting Algorithm for Edge Cases`_ -- [ ] Parse structured metadata: `priority`, `due`, etc. - _e.g., `TODO(priority=high, due=2025-06-01): improve this logic`_ -- [ ] Support for structured tags (`@assignee`, `#module`, etc.) +- [x] Heuristic label classification (`refactor`, `bug`, `test`, `doc`, etc.) +- [ ] LLM-powered title/body generation + _e.g., `Improve sort` β†’ `Optimize Sorting Algorithm for Edge Cases`_ +- [x] Enhanced metadata parsing (`@assignee`, `#module`, etc.) +- [x] Semantic label fallback when tag is ambiguous --- -## 🌍 Phase 3: Extended Support +## 🌍 Phase 3: Ecosystem Support -> Make the system flexible, extensible, and applicable to diverse environments. +> Expand support to other tools, file types, and languages. -- [ ] Multi-platform task integration (GitHub, Jira, Notion, Trello, Linear) -- [ ] Internationalization (i18n): multilingual TODO detection -- [ ] File format support: `.ipynb`, `.yaml`, `.json`, `.xml`, etc. +- [ ] Task sync with platforms: Jira, Notion, Trello, Linear +- [ ] Multilingual detection (i18n-ready) +- [ ] Parse formats beyond code: `.ipynb`, `.yaml`, `.json`, `.xml`, etc. --- -## πŸ“Š Phase 4: Insights & Reporting +## πŸ“Š Phase 4: Reporting & Insights -> Provide visibility into the evolution and structure of tracked TODOs. +> Provide visibility into TODO usage and evolution. -- [X] Markdown/HTML dashboard with summary statistics - _Total TODOs, grouped by folder, priority, author (`git blame`) β€” **now sorted by `priority` and `due` date**_ - -- [ ] TODO history tracking (added/removed/modified) -- [ ] Due date notifications or PR comments +- [x] Markdown dashboard (`TODO_REPORT.md`) + - Group by `priority`, `due`, `semantic label`, and `folder` +- [x] Changelog generation from grouped TODOs (`CHANGELOG.md`) +- [ ] TODO lifecycle tracking (added/removed/changed) +- [ ] Due date notifications (PR comments, issues, or Slack) --- -## πŸ” Phase 5: Optimization & Distribution +## πŸ” Phase 5: Performance & Distribution -> Final touches to ensure performance, scalability, and community usability. +> Make it fast, reliable, and easy to adopt across the community. -- [ ] Plugin-based architecture -- [ ] CLI support (standalone usage outside GitHub Actions) +- [ ] Plugin-based architecture (LLM integration, reporters, etc.) +- [ ] CLI mode (run locally or in CI/CD) - [ ] >90% test coverage -- [ ] Full documentation with usage examples +- [ ] Full documentation & usage guides - [ ] Publish to GitHub Marketplace --- ## πŸ“Œ Notes -- Clean architecture and modularity are core principles from day one. -- LLM functionality will be optional and clearly separated from core logic. -- Built with automation, extensibility, and developer workflows in mind. +- Built with extensibility and automation in mind. +- LLM functionality is **optional** and kept separate from core logic. +- Designed for teams who want visibility, traceability, and productivity with minimal friction. +