googlefonts/gftools

Main README usability and style improvements

Ouverte

#77 ouverte le 27 août 2018

Voir sur GitHub
 (0 commentaire) (0 réaction) (1 personne assignée)Python (73 forks)github user discovery
good first issue

Métriques du dépôt

Stars
 (279 étoiles)
Métriques de merge PR
 (Merge moyen 2j 6h) (5 PRs mergées en 30 j)

Description

The main README needs some simple usability and style improvements. The tone and assumed level of command line experience should make the README accessible to designers who are new to using CLI tools. However, instructions for things like setting up pip should be removed and replaced with links to official guides.

The Google Developer Documentation Style Guide should be used as a reference.

Guide contributeur

Direction de recherche
Examinez le README actuel par rapport au guide de style de documentation pour développeurs de Google, en vous concentrant sur la simplification du langage et le remplacement des instructions d'installation détaillées par des liens vers des guides officiels.
Stack technique
Aucun
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.
Moins d'une heure
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
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90