Help and error UX improvements #92
Merged
Conversation
This file contains 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
Prior to this commit the entry point for gh-changelog was fairly bland and did not provide a great UX for first time users. This commit is a step towards fixing that by ensuring that users have enough information to achieve the bare minumum by just running the `gh changelog` command without any subcommands.
This commit simply adds some more formatting to error messages that bubble up the the user. The idea is that the screen should be consistent and be formatted in a way that the user can easily grok what has gone wrong.
4173a80 to
6e2653b
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR focuses on UX improvements.
The text returned when running a bare
gh changeloghas been updated so that users haveenough information to achieve "just enough" with the tool.
Additionally improvements have been made to how error messages are displayed to users.