aspiers/git-deps

improve documentation

Open

#69 opened on Feb 10, 2018

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Python (55 forks)github user discovery
documentationhelp wanted

Repository metrics

Stars
 (318 stars)
PR merge metrics
 (PR metrics pending)

Description

In #39 @waldyrious made a bunch of excellent suggestions about how to improve the documentation. This issue is for tracking the associated work.

Contributor guide

Research direction
Review the suggestions in issue #39 and update the documentation files accordingly. Check the project's documentation structure and style guide.
Tech stack
python
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.
80