Add TODOs Badge to README
See original GitHub issueHi there! I wanted to propose adding the following badge to the README to indicate how many TODO
comments are in this codebase:
The badge links to tickgit.com
which is a free service that indexes and displays TODO comments in public github repos. It can help surface latent work and be a way for contributors to find areas of code to improve, that might not be otherwise documented.
The markdown is:
[![TODOs](https://badgen.net/https/api.tickgit.com/badgen/github.com/preactjs/preact)](https://www.tickgit.com/browse?repo=github.com/preactjs/preact)
Thanks for considering, feel free to close this issue if it’s not appropriate or you prefer not to!
Issue Analytics
- State:
- Created 4 years ago
- Comments:7 (5 by maintainers)
Top Results From Across the Web
Add TODOs Badge to README · Issue #3848 · knex ... - GitHub
Hi there! I wanted to propose adding the following badge to the README to indicate how many TODO comments are in this codebase:...
Read more >How to Add Badges to a GitHub Repository
Adding badges to the readme file of GitHub repositories is a common task for almost every new repository. These badges help in increasing...
Read more >How to improve your Github profile by adding badges
Badges are a great way to measure professional skills, so why not put them on your GitHub ... Add a badges only from...
Read more >readme-coverage-badger - PyPI
Generates a coverage badge using coverage.py and the shields.io service. Your README file is then updated with the generated badge. demo.gif. Source Code: ......
Read more >List of Badges, in Markdown - Naereen @ GitHub
A list of badges, with their Markdown code, that can be included in a README.md file for a GitHub or Bitbucket project. The...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
FWIW I really like the idea of having a tool for finding our open TODOs, but I don’t think we would want to use the badge. We actually are likely cutting down on the number of repo badges, since currently there’s a fair bit of noise.
@patrickdevivo I’m assuming you run
tickgit.com
- any chance you’re considering setting up a GitHub Action to bot that could highlight todos that are added/removed in PRs? I think we’d probably be interested in that more than the badge.FWIW I just got a chance to peek at the tickgit linked from our badge and I have to say, this is a very useful service. Badge stuff aside, thanks for building something like this!
While I do see some value in having an overview of the
TODO
s (andFIXIT
s, …), I don’t think a badge gives muchSeems like a metric for maintainers, not the general public