ThePrimeagen/uhh

Make the readme nicer

Open

#25 opened on Apr 29, 2020

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Go (6 forks)github user discovery
documentationgood first issue

Repository metrics

Stars
 (28 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

The readme should probably become a bit more professional with:

  • what is this program?
  • why not just save your bash history?
  • why not just use fzf?
  • installation
  • how to use multi repos
  • syncing and the issues.

Contributor guide

Research direction
Review the current README and add sections covering: project description, motivation, installation, usage with multiple repos, and syncing issues. Follow standard Go project README conventions such as a badge for Go version, installation via `go install`, and examples.
Tech stack
go
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.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90