|
1 | | -# 🗺️ Roadmap - Projeto `smart-todo-action` |
| 1 | +# 🗺️ Roadmap — `smart-todo-action` |
2 | 2 |
|
3 | | -Um GitHub Action inteligente para rastrear, classificar e transformar TODOs do seu código em issues inteligentes e contextualizadas. |
| 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. |
4 | 4 |
|
5 | 5 | --- |
6 | 6 |
|
7 | | -## 🧱 Fase 1: Fundações e Paridade com Projeto Original |
| 7 | +## 🧱 Phase 1: Foundations & Core Features |
8 | 8 |
|
9 | | -> Recriação da funcionalidade básica com código limpo, modular e testável. |
| 9 | +> Rebuild the original functionality with clean, modular, and testable code. |
10 | 10 |
|
11 | | -- [ ] Estrutura inicial do projeto (`src/`, `core/`, `parser/`, etc.) |
12 | | -- [ ] Parser de TODOs/FIXME/BUG com suporte multi-linguagem |
13 | | -- [ ] Sistema de tarefas inicial: integração com GitHub Issues |
14 | | -- [ ] Templates configuráveis para issues |
15 | | -- [ ] Configuração como GitHub Action (`action.yml`, workflow exemplo) |
16 | | -- [ ] Testes unitários com Jest/Vitest |
| 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 |
17 | 17 |
|
18 | 18 | --- |
19 | 19 |
|
20 | | -## 🧠 Fase 2: Inteligência e Semântica |
| 20 | +## 🧠 Phase 2: Intelligence & Semantics |
21 | 21 |
|
22 | | -> Adição de inteligência artificial e compreensão semântica aos TODOs. |
| 22 | +> Bring context-awareness and automation through LLMs and structured tags. |
23 | 23 |
|
24 | | -- [ ] Classificação automática (`bug`, `refactor`, `enhancement`, etc.) |
25 | | -- [ ] Geração automática de títulos e descrições via LLM |
26 | | -- [ ] Extração de `due date` e `priority` do texto dos TODOs |
27 | | -- [ ] Suporte a tags especiais (`@assignee`, `#module`, etc.) |
| 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.) |
28 | 30 |
|
29 | 31 | --- |
30 | 32 |
|
31 | | -## 🌍 Fase 3: Suporte Estendido |
| 33 | +## 🌍 Phase 3: Extended Support |
32 | 34 |
|
33 | | -> Tornar o projeto mais flexível, aplicável e adaptável a diferentes realidades. |
| 35 | +> Make the system flexible, extensible, and applicable to diverse environments. |
34 | 36 |
|
35 | | -- [ ] Integração com outros task managers (Jira, Notion, Linear, Trello) |
36 | | -- [ ] Internacionalização (detecção multilíngue de TODOs) |
37 | | -- [ ] Suporte a arquivos `.ipynb`, `.yaml`, `.json`, `.xml`, etc. |
| 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. |
38 | 40 |
|
39 | 41 | --- |
40 | 42 |
|
41 | | -## 📊 Fase 4: Análise e Relatórios |
| 43 | +## 📊 Phase 4: Insights & Reporting |
42 | 44 |
|
43 | | -> Adicionar insights e visualizações sobre o uso e evolução dos TODOs. |
| 45 | +> Provide visibility into the evolution and structure of tracked TODOs. |
44 | 46 |
|
45 | | -- [ ] Geração de dashboard (markdown/HTML) com métricas |
46 | | -- [ ] Agrupamento por pasta, prioridade, autor (`git blame`) |
47 | | -- [ ] Histórico de mudanças nos TODOs |
48 | | -- [ ] Notificações de TODOs próximos da data (`due date`) |
| 47 | +- [ ] Markdown/HTML dashboard with summary statistics |
| 48 | + _Total TODOs, grouped by folder, priority, author (`git blame`)_ |
| 49 | +- [ ] TODO history tracking (added/removed/modified) |
| 50 | +- [ ] Due date notifications or PR comments |
49 | 51 |
|
50 | 52 | --- |
51 | 53 |
|
52 | | -## 🔁 Fase 5: Otimizações e Distribuição |
| 54 | +## 🔁 Phase 5: Optimization & Distribution |
53 | 55 |
|
54 | | -> Melhorias finais para performance, manutenção e distribuição. |
| 56 | +> Final touches to ensure performance, scalability, and community usability. |
55 | 57 |
|
56 | | -- [ ] Arquitetura modular e plugável |
57 | | -- [ ] CLI standalone (fora do GitHub Actions) |
58 | | -- [ ] >90% de cobertura de testes |
59 | | -- [ ] Documentação completa |
60 | | -- [ ] Publicação oficial no GitHub Marketplace |
| 58 | +- [ ] Plugin-based architecture |
| 59 | +- [ ] CLI support (standalone usage outside GitHub Actions) |
| 60 | +- [ ] >90% test coverage |
| 61 | +- [ ] Full documentation with usage examples |
| 62 | +- [ ] Publish to GitHub Marketplace |
61 | 63 |
|
62 | 64 | --- |
63 | 65 |
|
64 | | -# 🚀 Roadmap para TODO Issue Tracker 2.0 |
| 66 | +## 📌 Notes |
65 | 67 |
|
66 | | -Este projeto tem como objetivo construir uma GitHub Action inteligente para rastrear, classificar e transformar TODOs do seu código em issues contextualizadas, com suporte a análise semântica e integração com múltiplas plataformas. |
| 68 | +- Clean architecture and modularity are core principles from day one. |
| 69 | +- LLM functionality will be optional and clearly separated from core logic. |
| 70 | +- Built with automation, extensibility, and developer workflows in mind. |
67 | 71 |
|
68 | 72 | --- |
69 | 73 |
|
70 | | -## 🧱 Fase 1: Fundações e Paridade com o Projeto Original |
| 74 | +# 🚀 Roadmap for TODO Issue Tracker 2.0 |
71 | 75 |
|
72 | | -🎯 Objetivo: Recriar a funcionalidade original com código limpo, modular e testável. |
| 76 | +This project aims to build an intelligent GitHub Action that scans your codebase for TODOs, classifies them, and transforms them into contextualized GitHub Issues — with semantic analysis and multi-platform integration. |
73 | 77 |
|
74 | | -- [ ] Criar estrutura base do projeto |
75 | | - - Pasta `src/` para código-fonte |
76 | | - - Subpastas: `core/`, `parser/`, `tasks/`, `templates/`, etc. |
| 78 | +--- |
| 79 | + |
| 80 | +## 🧱 Phase 1: Foundations and Parity with the Original Project |
| 81 | + |
| 82 | +🎯 Goal: Recreate the original functionality with clean, modular, and testable code. |
77 | 83 |
|
78 | | -- [ ] Implementar parser de TODOs |
79 | | - - Detectar comentários `TODO`, `FIXME`, `BUG`, etc. |
80 | | - - Suporte a múltiplas linguagens (`.js`, `.ts`, `.py`, `.go`, etc.) |
| 84 | +- [ ] Create the base project structure |
| 85 | + - `src/` folder for source code |
| 86 | + - Subfolders: `core/`, `parser/`, `tasks/`, `templates/`, etc. |
81 | 87 |
|
82 | | -- [ ] Sistema de tarefas inicial: GitHub Issues |
83 | | - - Criar, atualizar e remover issues com base nos TODOs encontrados |
| 88 | +- [ ] Implement TODO parser |
| 89 | + - Detect `TODO`, `FIXME`, `BUG`, etc. comments |
| 90 | + - Support for multiple languages (`.js`, `.ts`, `.py`, `.go`, etc.) |
84 | 91 |
|
85 | | -- [ ] Sistema de templates para criação de issues |
86 | | - - Títulos e descrições personalizáveis via templates |
| 92 | +- [ ] Initial task system: GitHub Issues |
| 93 | + - Create, update, and remove issues based on detected TODOs |
87 | 94 |
|
88 | | -- [ ] Workflow GitHub Action funcional |
89 | | - - Arquivo `action.yml` |
90 | | - - Exemplo de uso em `.github/workflows/todo.yml` |
| 95 | +- [ ] Templating system for issue creation |
| 96 | + - Customizable titles and descriptions via templates |
91 | 97 |
|
92 | | -- [ ] Testes unitários com Jest ou Vitest |
| 98 | +- [ ] Functional GitHub Action workflow |
| 99 | + - `action.yml` definition file |
| 100 | + - Example usage in `.github/workflows/todo.yml` |
| 101 | + |
| 102 | +- [ ] Unit testing with Jest or Vitest |
93 | 103 |
|
94 | 104 | --- |
95 | 105 |
|
96 | | -## 🧠 Fase 2: Inteligência e Semântica |
| 106 | +## 🧠 Phase 2: Intelligence and Semantics |
97 | 107 |
|
98 | | -🎯 Objetivo: Tornar o sistema mais inteligente, aproveitando LLMs e contexto semântico. |
| 108 | +🎯 Goal: Make the system smarter by leveraging LLMs and contextual awareness. |
99 | 109 |
|
100 | | -- [ ] Classificação automática de TODOs |
101 | | - - Usar LLMs ou regras heurísticas para classificar como `bug`, `enhancement`, `refactor`, etc. |
| 110 | +- [ ] Automatic TODO classification |
| 111 | + - Use LLMs or heuristics to classify as `bug`, `enhancement`, `refactor`, etc. |
102 | 112 |
|
103 | | -- [ ] Geração de título e descrição automática via LLM |
104 | | - - Exemplo: `Revisar algoritmo de ordenação` → `Optimize Sorting Algorithm for Edge Cases` |
| 113 | +- [ ] Auto-generate issue titles and descriptions using LLMs |
| 114 | + _Example: `Review sorting algorithm` → `Optimize Sorting Algorithm for Edge Cases`_ |
105 | 115 |
|
106 | | -- [ ] Extração de `due date` e `priority` via parsing |
107 | | - - Exemplo: `TODO(priority=high, due=2025-06-01): melhorar isso` |
| 116 | +- [ ] Extract `due date` and `priority` via inline metadata parsing |
| 117 | + _Example: `TODO(priority=high, due=2025-06-01): improve this logic`_ |
108 | 118 |
|
109 | 119 | --- |
110 | 120 |
|
111 | | -## 🌍 Fase 3: Suporte Estendido |
| 121 | +## 🌍 Phase 3: Extended Support |
112 | 122 |
|
113 | | -🎯 Objetivo: Tornar o sistema flexível e útil para ambientes diversos. |
| 123 | +🎯 Goal: Make the project adaptable to diverse environments and workflows. |
114 | 124 |
|
115 | | -- [ ] Suporte a múltiplos sistemas de tarefas |
116 | | - - GitHub, Jira, Notion, Trello, Linear (via APIs) |
| 125 | +- [ ] Support for multiple task management platforms |
| 126 | + _GitHub, Jira, Notion, Trello, Linear (via APIs)_ |
117 | 127 |
|
118 | | -- [ ] Internacionalização (i18n) |
119 | | - - Detecção automática de TODOs em diversas línguas |
| 128 | +- [ ] Internationalization (i18n) |
| 129 | + _Detect TODOs written in different languages_ |
120 | 130 |
|
121 | | -- [ ] Suporte a mais formatos de arquivos |
122 | | - - `.ipynb`, `.yaml`, `.md`, `.json`, `.xml`, entre outros |
| 131 | +- [ ] Support for additional file types |
| 132 | + _`.ipynb`, `.yaml`, `.md`, `.json`, `.xml`, and more_ |
123 | 133 |
|
124 | 134 | --- |
125 | 135 |
|
126 | | -## 📊 Fase 4: Análise e Relatórios |
| 136 | +## 📊 Phase 4: Analysis and Reporting |
127 | 137 |
|
128 | | -🎯 Objetivo: Dar visibilidade sobre o estado e evolução dos TODOs. |
| 138 | +🎯 Goal: Provide visibility into the state and evolution of TODOs. |
129 | 139 |
|
130 | | -- [ ] Dashboard em Markdown ou HTML |
131 | | - - Total de TODOs |
132 | | - - Agrupamento por pasta, prioridade, autor (via `git blame`) |
| 140 | +- [ ] Markdown/HTML dashboard with metrics |
| 141 | + _Total TODOs, grouped by folder, priority, author (`git blame`)_ |
133 | 142 |
|
134 | | -- [ ] Histórico de TODOs |
135 | | - - Rastrear adições e remoções ao longo do tempo |
| 143 | +- [ ] TODO history tracking |
| 144 | + _Track when TODOs are added, removed, or changed over time_ |
136 | 145 |
|
137 | | -- [ ] Notificações e lembretes |
138 | | - - Comentários automáticos em PRs/issues ao se aproximar a `due date` |
| 146 | +- [ ] Notifications and reminders |
| 147 | + _Comment on PRs or issues when due dates are approaching_ |
139 | 148 |
|
140 | 149 | --- |
141 | 150 |
|
142 | | -## 🔁 Fase 5: Otimizações e Contribuições |
| 151 | +## 🔁 Phase 5: Optimizations and Contributions |
143 | 152 |
|
144 | | -🎯 Objetivo: Garantir qualidade e facilitar manutenção. |
| 153 | +🎯 Goal: Ensure quality, performance, and ease of collaboration. |
145 | 154 |
|
146 | | -- [ ] Arquitetura com módulos plugáveis |
147 | | -- [ ] Cobertura de testes superior a 90% |
148 | | -- [ ] Suporte a CLI standalone (fora do GitHub Actions) |
149 | | -- [ ] Documentação completa com exemplos de uso |
150 | | -- [ ] Publicação como GitHub Action oficial no Marketplace |
| 155 | +- [ ] Plugin-based modular architecture |
| 156 | +- [ ] CLI support (standalone usage outside GitHub Actions) |
| 157 | +- [ ] Test coverage >90% |
| 158 | +- [ ] Full documentation with usage examples |
| 159 | +- [ ] Publish to GitHub Marketplace as an official Action |
151 | 160 |
|
152 | 161 | --- |
153 | 162 |
|
154 | | -## 📌 Observações |
| 163 | +## 📌 Notes |
| 164 | + |
| 165 | +- Modularity, testability, and code clarity are priorities from day one. |
| 166 | +- LLM integration will be optional and cleanly decoupled from core logic. |
| 167 | +- Designed with automation, extensibility, and developer experience in mind. |
155 | 168 |
|
156 | | -- Modularidade, testes e clareza são prioridades desde o início |
157 | | -- Integração com LLMs será opcional e desacoplada do core |
|
0 commit comments