Update README and improve error messages in register.go #64
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
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.
# Motivation
There are many projects that use/will use CLI and there were some points that caught my attention while installing Mangata.
Error Handling: Our error messages around configuration files could really use some work. Let's make them more specific about what's going wrong (file not found, bad format, etc.), give them the file path, and maybe even suggest some troubleshooting steps
Upgrade Instructions: It'd be awesome to have a clear guide on updating the CLI right from the source
# Solution
Error Handling: Tweaked the functions that deal with config files to give way better error messages
Upgrade Instructions: Added some simple upgrade steps either in the README separate
# Open Questions