ThePrimeagen/uhh

Make the readme nicer

Aperta

#25 aperta il 29 apr 2020

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)Go (6 fork)github user discovery
documentationgood first issue

Metriche repository

Star
 (28 stelle)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

The readme should probably become a bit more professional with:

  • what is this program?
  • why not just save your bash history?
  • why not just use fzf?
  • installation
  • how to use multi repos
  • syncing and the issues.

Guida contributor

Direzione di ricerca
Esamina il README attuale e aggiungi sezioni che coprono: descrizione del progetto, motivazione, installazione, utilizzo con più repository e problemi di sincronizzazione. Segui le convenzioni standard dei README dei progetti Go, come un badge per la versione Go, installazione tramite `go install` ed esempi.
Tech stack
go
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.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Nessuno
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90