mapbox / mapbox/wellknown

Show more succinct CLI help instead of README

Open
#39 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
281
Forks
47
PR merge metrics
No merged PRs in 30d

Description

It's a little "cheap" to just dump the entire README markdown file when one runs the `wellknown` CLI command or even by specifying the `--help` option. I think it's not too much to ask to display a few helpful lines for well-rounded CLI usability, no?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the wellknown CLI entry point and inspect how the README is displayed for the command and for --help. Define a short set of helpful CLI lines, then verify that both invocation paths show the concise help instead of the full README.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
cli
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.