lsd-rs/lsd

Improve the documentation

Open

#120 opened on Feb 9, 2019

View on GitHub
 (1 comment) (2 reactions) (0 assignees)Rust (434 forks)batch import
help wantedkind/enhancement

Repository metrics

Stars
 (13,400 stars)
PR merge metrics
 (Avg merge 34d 3h) (2 merged PRs in 30d)

Description

It would be great to have a FAQ or a Known Issues section into the README. The possible content would be:

  • The terminal related bugs with the icons (#118).
  • How to configure properly the terminal font (#117)
  • Some documentation about the default configuration (#113)
  • The snap without --classic "bug" (#127 )

Contributor guide

Research direction
Review the referenced issues and add a FAQ or Known Issues section to the README based on common questions.
Tech stack
rust
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.
95