googlefonts/gftools

Main README usability and style improvements

Offen

#77 geöffnet am 27.08.2018

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (1 zugewiesene Person)Python (73 Forks)github user discovery
good first issue

Repository-Metriken

Stars
 (279 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 2T 6h) (5 gemergte PRs in 30 T)

Beschreibung

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.

Contributor Guide

Research-Richtung
Überprüfen Sie die aktuelle README anhand des Google Developer Documentation Style Guide, wobei der Schwerpunkt auf der Vereinfachung der Sprache und dem Ersetzen detaillierter Installationsanweisungen durch Links zu offiziellen Anleitungen liegt.
Tech Stack
Keine
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.
Unter 1 Stunde
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
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90