conventional-changelog/standard-version

docs: add detailed documentation in a docs/ folder

Open

#226 aperta il 29 nov 2017

Vedi su GitHub
 (0 commenti) (5 reazioni) (0 assegnatari)JavaScript (825 fork)batch import
enhancementhelp wanted

Metriche repository

Star
 (7442 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

I think standard-version would benefit from an approach I recently took with yargs, introducing additional detailed help information in a docs/ folder. Sections that immediately come to mind:

  • docs/advanced.md: advanced tips and tricks (generating a CHANGELOG from scratch, real-world examples of lifecycle scripts).
  • docs/FAQ.md: frequently asked questions about conventional-commits, e.g., why are some commits in the CHANGELOG and others not?

CC: @stevemao @nexdrew

Guida contributor

Direzione di ricerca
Crea una cartella docs/ nella radice del repository. Aggiungi docs/advanced.md con suggerimenti e trucchi avanzati per l'uso di standard version, come la generazione di un CHANGELOG da zero ed esempi reali di script del ciclo di vita. Aggiungi docs/FAQ.md con domande frequenti sui commit convenzionali, spiegando perché alcuni commit appaiono nel CHANGELOG e altri no. Assicurati che entrambi i file utilizzino la formattazione Markdown.
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.
90