streamich/git-cz

Docs cleanup

Aperta

#121 aperta il 16 gen 2020

Vedi su GitHub
 (1 commento) (0 reazioni) (0 assegnatari)JavaScript (111 fork)github user discovery
good first issuehelp wanted📓 documentation

Metriche repository

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

Descrizione

  • Move most of the contents of README.md into separate files:
    • /docs/Installation.md
    • /docs/Configuration.md
    • add /docs/CLI-options.md
    • /docs/Semantic-commits.md
  • Keep in README.md
    • Screenshot
    • Add more badges
    • Quick-start comand npx git-cz
    • Links to docs in /docs folder

Guida contributor

Direzione di ricerca
Crea i file di documentazione separati come elencati nella checklist, poi aggiorna README.md per includere i link a essi.
Tech stack
javascript
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
GitMarkdown
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85