conventional-changelog/standard-version

docs: add detailed documentation in a docs/ folder

Open

#226 opened on Nov 29, 2017

View on GitHub
 (0 comments) (5 reactions) (0 assignees)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

Contributor guide

Tech stack
javascriptnodejs
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
conventional commitsstandard version usageMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
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.