conventional-changelog/standard-version

docs: add detailed documentation in a docs/ folder

Open

#226 geöffnet am 29. Nov. 2017

Auf GitHub ansehen
 (0 Kommentare) (5 Reaktionen) (0 zugewiesene Personen)JavaScript (7.442 Stars) (825 Forks)batch import
enhancementhelp wanted

Beschreibung

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

Contributor Guide

Tech Stack
javascriptnodejs
Domain
documentation
Issue Type
documentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
half day
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
conventional commitsstandard version usageMarkdown
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70
Research-Richtung
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.