conventional-changelog/standard-version

docs: add detailed documentation in a docs/ folder

Open

#226 ouverte le 29 nov. 2017

Voir sur GitHub
 (0 commentaires) (5 réactions) (0 assignés)JavaScript (7 442 stars) (825 forks)batch import
enhancementhelp wanted

Description

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

Guide contributeur

Stack technique
javascriptnodejs
Domaine
documentation
Type d'issue
documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
half day
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
conventional commitsstandard version usageMarkdown
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70
Direction de recherche
The issue requests creating a docs/ folder with advanced.md and FAQ.md. Examine the existing README for documentation style and any existing docs. Look at the referenced yargs documentation approach. Since the issue is from 2017 and has no recent activity, comment to confirm maintainers still desire this contribution. Follow any contribution guidelines in the repository.