OpenGenus/cosmos

Add documentation in README.md inside each algorithm.

Open

#331 aperta il 3 ott 2017

Vedi su GitHub
 (9 commenti) (3 reazioni) (0 assegnatari)C++ (3724 fork)batch import
Hacktoberfestadd code

Metriche repository

Star
 (13.462 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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?

Guida contributor

Direzione di ricerca
Tech stack
Dominio
Tipo issue
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Prerequisiti
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.