streamich/git-cz

Docs cleanup

開放

#121 建立於 2020年1月16日

在 GitHub 查看
 (1 則留言) (0 個反應) (0 位負責人)JavaScript (111 個分叉)github user discovery
good first issuehelp wanted📓 documentation

倉庫指標

星標
 (1,872 顆星)
PR 合併指標
 (30 天內沒有已合併 PR)

描述

  • Move most of the contents of README.md into separate files:
    • /docs/Installation.md
    • /docs/Configuration.md
    • add /docs/CLI-options.md
    • /docs/Semantic-commits.md
  • Keep in README.md
    • Screenshot
    • Add more badges
    • Quick-start comand npx git-cz
    • Links to docs in /docs folder

貢獻者指南

研究方向
按照清單創建單獨的文檔文件，然後更新README.md以包含指向它們的鏈接。
技術棧
javascript
領域
documentation
議題類型
文件
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
1
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 小時
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
活躍
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
GitMarkdown
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
85