googlefonts/gftools

Main README usability and style improvements

Open

#77 opened on Aug 27, 2018

View on GitHub
 (0 comments) (0 reactions) (1 assignee)Python (73 forks)github user discovery
good first issue

Repository metrics

Stars
 (279 stars)
PR merge metrics
 (Avg merge 2d 6h) (5 merged PRs in 30d)

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.

Contributor guide

Research direction
Review the current README against the Google Developer Documentation Style Guide, focusing on simplifying language and replacing detailed installation instructions with links to official guides.
Tech stack
None
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.
Under 1 hour
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
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90