ankitaggarwal011/PyCNN

Add contributing guidelines to the project

Open

#14 aperta il 3 ott 2016

Vedi su GitHub
 (3 commenti) (0 reazioni) (0 assegnatari)Python (86 fork)batch import
documentationeasyhacktoberfesthelp wanted

Metriche repository

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

Descrizione

This will make things easier for the contributors.

Some important points to be highlighted in the contributing guide would be:

  • How to contribute - improve documentation/add new methods/improve performance.
  • Explain contribution workflow - issues/pull-request/review.
  • An overview of code structure and API.
  • Coding practices to follow.
  • Guide to add a new image processing method.

Any suggestions are welcome. Thanks.

Guida contributor

Direzione di ricerca
Esamina la struttura attuale del repository, identifica le aree chiave come l'organizzazione del codice, i test e la documentazione dell'API, quindi redige le linee guida per i contributori seguendo le migliori pratiche di progetti open source simili.
Tech stack
python
Dominio
computer visiondocumentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
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
GitGitHub
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90