googlefonts/gftools

Main README usability and style improvements

Aperta

#77 aperta il 27 ago 2018

Vedi su GitHub
 (0 commenti) (0 reazioni) (1 assegnatario)Python (73 fork)github user discovery
good first issue

Metriche repository

Star
 (279 stelle)
Metriche merge PR
 (Merge medio 2g 6h) (5 PR mergiate in 30 g)

Descrizione

The main README needs some simple usability and style improvements. The tone and assumed level of command line experience should make the README accessible to designers who are new to using CLI tools. However, instructions for things like setting up pip should be removed and replaced with links to official guides.

The Google Developer Documentation Style Guide should be used as a reference.

Guida contributor

Direzione di ricerca
Rivedi il README attuale rispetto alla Guida allo stile della documentazione per sviluppatori di Google, concentrandoti sulla semplificazione del linguaggio e sulla sostituzione delle istruzioni di installazione dettagliate con collegamenti alle guide ufficiali.
Tech stack
Nessuno
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.
Meno di 1 ora
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.
90