portkey-cloud/portkey

Write a good README

Open

#30 aperta il 6 set 2017

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)Clojure (7 fork)github user discovery
documentationhelp wanted

Metriche repository

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

Descrizione

Write a README assuming no AWS knowledge that guide the user step by step.

Guida contributor

Direzione di ricerca
Esamina i README esistenti di progetti simili per la struttura, poi scrivi una guida passo passo che copra installazione, configurazione, uso di base ed esempi per Portkey, presupponendo nessuna conoscenza di AWS.
Tech stack
clojure
Dominio
documentation
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
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85