OpenGenus/cosmos

Explanation file of implemented code

Open

#4957 aperta il 30 mar 2020

Vedi su GitHub
 (8 commenti) (0 reazioni) (1 assegnatario)C++ (3724 fork)batch import
enhancementgood first issue

Metriche repository

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

Descrizione

This is a(n):

  • New algorithm
  • Update to an existing algorithm
  • Error
  • Proposal to the Repository

Details:

We can make a file may be READ.md file in every algorithm. reading code without explanation is difficult for learners so I am proposing an explanation of implemented programs using gifs, text, or any pictorial method. Reading merely code doesn't help much but explanation does help. I would like to work on it.

Guida contributor

Direzione di ricerca
Scegli un algoritmo dal repository, studia il suo codice e crea un file README.md spiegando l'algoritmo con testo e diagrammi. Includi esempi e analisi di complessità.
Tech stack
Nessuno
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80