tldr-pages/tldr

Let's document! Git edition

Open

#3,953 opened on Mar 30, 2020

View on GitHubContributor guide
 (18 comments) (16 reactions) (0 assignees)Markdown (5,381 forks)batch import
good first issuehelp wantedlet's documentnew command

Repository metrics

Stars
 (63,468 stars)
PR merge metrics
 (PR metrics pending)

Description

For those not in the know, tldr-pages is about more than just commands. Those commands that are too expansive to fit on 1 page often have multiple subcommands - which we can document on their own pages. For example, try these:

tldr git merge
tldr git add
tldr ip address

In the case of git, it has quite a number of subcommands (139 ❗). Let's document them all!

Contributor guide

Research direction
Pick an unchecked git subcommand from the list (e.g., `archimport`, `cvsimport`), read its official documentation on git scm.com, and create a new tldr page following the project's style guidelines. Submit a pull request with the page addition.
Tech stack
shell
Domain
documentationcli
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
Gittldr pages conventions
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90