Go-github: Add TODOs badge to README

[patrickdevivo]

Hi 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 new contributors to find areas of code to improve.

The markdown is:

[![TODOs](https://img.shields.io/endpoint?url=https://todos.tickgit.com/badge?repo=github.com/google/go-github)](https://todos.tickgit.com/browse?repo=github.com/google/go-github)

Thanks for considering, feel free to close this issue if it's not appropriate or you prefer not to add the badge!

[gmlewis]

Cool! I didn't know about that badge.

Looking through the TODOs, the vast majority are to remove a custom header when the API fully launches.

I'm fine with adding this badge to the top-level README.md.

[willnorris]

Given that the vast majority of our TODOs are about removing custom headers, I don't think this actually adds any value to the project, and just adds more noise at the top of our (admittedly, already a little noisy) README file.

(I also don't love the fact that it looks like @patrickdevivo made this kind of drive-by contribution to a dozen different projects on Saturday. Those often end up being spam contributions, or simply promoting one's own project, which is also what this seems to be.)

/shrug

[gmlewis]

Oh, sorry, @willnorris. We can either revert or we can remove it with another PR... your call.

[willnorris]

either way. And no worries

On Mon, Feb 3, 2020 at 12:03 PM Glenn Lewis [e-mail]
wrote:

Oh, sorry, @willnorris https://github.com/willnorris. We can either
revert or we can remove it with another PR... your call.

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
https://github.com/google/go-github/issues/1406?email_source=notifications&email_token=AAAAIWBFC7IWX7JXCHO7N4TRBB2BVA5CNFSM4KOXNK6KYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEKVGOFI#issuecomment-581592853,
or unsubscribe
https://github.com/notifications/unsubscribe-auth/AAAAIWGNQJCYXAAGDNM23FLRBB2BVANCNFSM4KOXNK6A
.

[gmlewis]

OK, I'll just revert then later tonight.

[patrickdevivo]

I’m sorry the issue I opened felt like spam - it certainly was a “drive by”
in an effort to get the word out for a project I’m working on, and I
apologize that didn’t “taste right.” I do promise that the intent of my
opening the issue/PR was genuine in that I do believe the TODO index can
provide value to some projects (as TODO comments are often simply
forgotten).

I understand if you don’t feel like there’s a value add to this repo - it
is funny that pretty much all 161 TODOs are essentially the same phrase!
Thank you for considering it in the first place.

As a side note - I'm hoping to soon make it easy to create Github issues
from TODOs in the index, among other features to make it more of an
"actionable" tool rather than just a big list.

On Mon, Feb 3, 2020 at 3:26 PM Glenn Lewis [e-mail] wrote:

OK, I'll just revert then later tonight.

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
https://github.com/google/go-github/issues/1406?email_source=notifications&email_token=AAAN7K37SSVIOGHE44Y2TMLRBB4YNA5CNFSM4KOXNK6KYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEKVIX4Q#issuecomment-581602290,
or unsubscribe
https://github.com/notifications/unsubscribe-auth/AAAN7K3T5JZ7TLDZ7RRZMMLRBB4YNANCNFSM4KOXNK6A
.