conventional-changelog/standard-version

docs: add detailed documentation in a docs/ folder

Open

#226 建立於 2017年11月29日

在 GitHub 查看
 (0 留言) (5 反應) (0 負責人)JavaScript (7,442 star) (825 fork)batch import
enhancementhelp wanted

描述

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

貢獻者指南

技術棧
javascriptnodejs
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
half day
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
conventional commitsstandard version usageMarkdown
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
70
研究方向
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.
docs: add detailed documentation in a docs/ folder · conventional-changelog/standard-version#226 | Good First Issue