ghcv-cli icon indicating copy to clipboard operation
ghcv-cli copied to clipboard

Clarify scope at start of README and GitHub about field

Open peterjc opened this issue 11 months ago • 0 comments

Project scope unclear

The README starts:

ghcv-cli

ghcv-cli makes it easy to view the user-created issues, pull requests, and repositories in the terminal.

The about text in the repository (top right) reads: "view the user-created issues, pull requests, and repositories in the terminal 🧑‍💻"

The scope is unclear to me from this.

Suggestion

For the about text, how about "View the user-created issues, pull requests, and repositories on GitHub in the terminal 🧑‍💻"

From the context I guess the name is short for something like "GitHub Contributions Viewer - Command Line Interface", perhaps spell this out explicitly as the opening sentence? e.g.

GitHub Contributions Viewer - Command Line Interface (ghcv-cli) makes it easy to view the user-created issues, pull requests, and repositories in the terminal. This is a user-centric perspective, aimed at people who contribute to multiple repositories, rather than a tool for a repository maintainer dealing with incoming issues and pull requests.

That second sentence is based on my initial impression from the rest of the README. I have not tried the tool, I was just curious what else you worked on in addition to serie.

peterjc avatar Jan 31 '25 11:01 peterjc