question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Add TODOs Badge to README

See original GitHub issue

Hi there! I wanted to propose adding the following badge to the README to indicate how many TODO comments are in this codebase:

TODOs

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:closed
  • Created 4 years ago
  • Comments:7 (5 by maintainers)

github_iconTop GitHub Comments

5reactions
developitcommented, Feb 27, 2020

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!

3reactions
ForsakenHarmonycommented, Feb 27, 2020

While I do see some value in having an overview of the TODOs (and FIXITs, …), I don’t think a badge gives much

Seems like a metric for maintainers, not the general public

Read more comments on GitHub >

github_iconTop 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 >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found