streamich/git-cz

Docs cleanup

Offen

#121 geöffnet am 16.01.2020

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)JavaScript (111 Forks)github user discovery
good first issuehelp wanted📓 documentation

Repository-Metriken

Stars
 (1.872 Sterne)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

  • 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-Richtung
Erstellen Sie die separaten Dokumentationsdateien gemäß der Checkliste und aktualisieren Sie die README.md, um Links zu ihnen hinzuzufügen.
Tech Stack
javascript
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitMarkdown
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85