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