vesoft-inc/nebula

Add TODOs Badge to README

Open

#1 868 ouverte le 4 mars 2020

Voir sur GitHub
 (7 commentaires) (1 réaction) (1 assigné)C++ (1 144 forks)batch import
communitygood first issuepriority/low-pritype/feature req

Métriques du dépôt

Stars
 (9 828 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

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/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)

Guide contributeur

Direction de recherche
Ajoutez le markdown du badge au fichier README, spécifiquement dans la section des badges près du haut.
Stack technique
Aucun
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90