Automated README Progress Badges & Table #447

New issue

Open

opened 2025-10-14 15:55:14 -06:00 by navan · 0 comments

navan commented

2025-10-14 15:55:14 -06:00

Owner

Originally created by @Mi-Lan on 6/20/2025

As a contributor, I want every change to .taskmaster/tasks.json to update the README in the github repo with live task-status icons and a progress table, so newcomers instantly see project status without digging into JSON or CI logs.

Example:

Motivation

Its so much easier to keep track of tasks like this then to look in the repo. And if multiple people are working or reviewing pr this is really neat feature

Proposed Solution

• Overview – Extend mcp-server/src/tools/update.* so, after it writes the mutated tasks.json, it calls a new helper updateReadmeProgress()
• Tech – Pure Node (fs, path). No extra deps.
• Fit – Keeps the current CLI/MCP contract intact; the tool already touches the same files, so adding a README write is trivial.

Example Workflow

$ task-master update_task --id=7.1 --status=done
✔ Task 7.1 marked done
✔ README updated → 15 / 42 tasks (36%)

*Originally created by @Mi-Lan on 6/20/2025* ### As a contributor, I want every change to .taskmaster/tasks.json to update the README in the github repo with live task-status icons and a progress table, so newcomers instantly see project status without digging into JSON or CI logs. Example: ![Image](https://github.com/user-attachments/assets/1b526221-75b4-4315-a19d-9c5ca1433a9f) ### Motivation Its so much easier to keep track of tasks like this then to look in the repo. And if multiple people are working or reviewing pr this is really neat feature ### Proposed Solution • Overview – Extend mcp-server/src/tools/update.* so, after it writes the mutated tasks.json, it calls a new helper updateReadmeProgress() • Tech – Pure Node (fs, path). No extra deps. • Fit – Keeps the current CLI/MCP contract intact; the tool already touches the same files, so adding a README write is trivial. ### Example Workflow $ task-master update_task --id=7.1 --status=done ✔ Task 7.1 marked done ✔ README updated → 15 / 42 tasks (36%)