mono/Embeddinator-4000

[general] Improve docs, showcase and contributing section

Open

#160 aperta il 22 apr 2017

Vedi su GitHub
 (2 commenti) (0 reazioni) (1 assegnatario)C# (91 fork)github user discovery
enhancementhelp wanted

Metriche repository

Star
 (758 star)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

Currently the github page of Embeddinator is lacking detailed information about how it works, where it's useful, how to contribute etc. I consider this as very important.

My suggestions is following: Start with adding a wiki which describes in more detail how to use it, add some examples both to the repository and the wiki and at least at a contributing.md .

Guida contributor

Direzione di ricerca
Esamina la documentazione esistente, quindi crea una pagina wiki con esempi di utilizzo e un file CONTRIBUTING.md. Segui lo stile esistente del progetto e collega le risorse pertinenti.
Tech stack
csharp
Dominio
documentationdevtools
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.
75