streamich/git-cz

Docs cleanup

Open

#121 opened on Jan 16, 2020

View on GitHub
 (1 comment) (0 reactions) (0 assignees)JavaScript (111 forks)github user discovery
good first issuehelp wanted📓 documentation

Repository metrics

Stars
 (1,872 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

  • 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

Contributor guide

Research direction
Create the separate documentation files as listed in the checklist, then update README.md to include links to them.
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.
85