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 (825 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (7,442 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Create a docs/ folder in the root of the repository. Add docs/advanced.md with advanced tips and tricks for using standard version, such as generating a CHANGELOG from scratch and real world examples of lifecycle scripts. Add docs/FAQ.md with frequently asked questions about conventional commits, explaining why some commits appear in the CHANGELOG and others do not. Ensure both files use Markdown formatting.
Tech stack
javascript
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90