prikhi/pencil

code uncommented, hard to read: Help adding comments

Open

#704 aperta il 5 giu 2015

Vedi su GitHub
 (6 commenti) (0 reazioni) (0 assegnatari)JavaScript (199 fork)batch import
DocsPriority-Criticalenhancementhelp wanted

Metriche repository

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

Descrizione

Context: Not a feature or bug of the application itself, but as a help for anyone who wants to improve this project Problem: The code is mainly uncommented and it is hard to get into it. Suggestion: To anyone who knows the code a bit: Please add comments to the code in particular on top of files and functions.

Guida contributor

Direzione di ricerca
Esplora il codebase per capire i file e le funzioni principali, quindi aggiungi commenti descrittivi all'inizio dei file e prima delle funzioni per spiegarne lo scopo e la funzionalità di base.
Tech stack
javascript
Dominio
desktop
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.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75