Add TODOs Badge to README - Githubissues

vesoft-inc / nebula

A distributed, fast open-source graph database featuring horizontal scalability and high availability

https://nebula-graph.io

Apache License 2.0

10.68k stars 1.2k forks source link

Add TODOs Badge to README #1868

Open patrickdevivo opened 4 years ago

patrickdevivo commented 4 years ago

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 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/vesoft-inc/nebula)](https://www.tickgit.com/browse?repo=github.com/vesoft-inc/nebula)

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

(full disclosure, I am the creator/maintainer of tickgit)

Shylock-Hg commented 4 years ago

@jude-zhu I think it's a great tool.

patrickdevivo commented 4 years ago

Just bumping this to see if anyone would like me to open up a PR! Thanks for considering, I hope it's a useful tool.

AniketNS commented 1 year ago

Hey @Sophie-Xie, I would like to work on this issue. Please assign this to me.

wey-gu commented 1 year ago

Dear @AniketNS ,

Assigned to you:) thanks for your contribution!

AniketNS commented 1 year ago

Thanks, @wey-gu for assigning this issue to me. I'll create the PR by tomorrow.

AniketNS commented 1 year ago

Hey @wey-gu, I've added the TODOs badge. But I'm not able to keep it in the center. Can you please guide me on how can I do that?

Nebula TODOs badge

AniketNS commented 1 year ago

Hello @patrickdevivo, can you please see what I've done? Is it what you wanted?