streamich/git-cz

Docs cleanup

Ouverte

#121 ouverte le 16 janv. 2020

Voir sur GitHub
 (1 commentaire) (0 réaction) (0 personne assignée)JavaScript (111 forks)github user discovery
good first issuehelp wanted📓 documentation

Métriques du dépôt

Stars
 (1 872 étoiles)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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

Guide contributeur

Direction de recherche
Créez les fichiers de documentation séparés comme indiqué dans la liste de vérification, puis mettez à jour le README.md pour inclure des liens vers eux.
Stack technique
javascript
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitMarkdown
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85