OpenGenus/cosmos

Add documentation in README.md inside each algorithm.

Open

#331 ouverte le 3 oct. 2017

Voir sur GitHub
 (9 commentaires) (3 réactions) (0 assignés)C++ (3 724 forks)batch import
Hacktoberfestadd code

Métriques du dépôt

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

Description

So I noticed there's a README.md file inside each folder that actually provides no useful information.

What about we change each README.md file, for example cosmos/code/search/ternary_search/README.md to explain a bit about the Ternary Search algorithm?

Guide contributeur

Direction de recherche
Stack technique
Domaine
Type d'issue
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Prérequis
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.