athityakumar/colorls

-r option not accurately documented

Open

#192 opened on May 27, 2018

View on GitHubContributor guide
 (6 comments) (0 reactions) (0 assignees)Ruby (395 forks)batch import
DocumentationHacktoberfestUp-For-Grabs

Repository metrics

Stars
 (5,135 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Description

macOS v. 10.13.4 Using Terminal.app

Report displays properly with --report, but not -r. Here's the relevant documentation.

  • Relevant Issues : (none)
  • Relevant PRs : (none)
  • Type of issue :
    • Documentation

Contributor guide

Research direction
Locate the documentation source file for the r option and update it to match the actual behavior.
Tech stack
ruby
Domain
cli
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
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90