📖 Improve CLI help with quick start examples#4995
Closed
sachin9058 wants to merge 1 commit intoossf:mainfrom
Closed
📖 Improve CLI help with quick start examples#4995sachin9058 wants to merge 1 commit intoossf:mainfrom
sachin9058 wants to merge 1 commit intoossf:mainfrom
Conversation
sachin9058
requested review from
AdamKorcz and
spencerschrock
and removed request for
a team
dosubot
Bot
added
the
size:S
Signed-off-by: Sachin Kumar <sachinkumar905846@gmail.com>
sachin9058
force-pushed
the
improve-cli-help
branch
from
8085032 to
cc7855a
Compare
Author
|
Hi, I have updated the PR and resolved the DCO issue. Please let me know if any further changes are needed. |
sachin9058
changed the title
|
This pull request has been marked stale because it has been open for 10 days with no activity |
Member
|
Thanks for the contribution, but there are examples in the README, and I don't feel they should belong in the CLI usage string. Plus |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What kind of change does this PR introduce?
This PR introduces a documentation/UX improvement by enhancing the CLI help output.
What is the current behavior?
The CLI help output provides basic usage information but lacks clear examples and quick-start guidance, which can make it less intuitive for new users.
What is the new behavior (if this is a feature change)?
The CLI help output is improved by:
Adding a Quick Start section with a simple usage example
Providing a concrete example using a real repository
Adding a note clarifying required input flags
Improving overall readability and usability for beginners
Tests for the changes have been added (not applicable as this is a documentation/UX improvement)
Which issue(s) this PR fixes
NONE
Special notes for your reviewer
This change only updates the CLI help text (
scorecardLongand usage description) and does not modify any core functionality.Does this PR introduce a user-facing change?
Yes