feat: make bug reporting information more actionable MONGOSH-459 #1043
Conversation
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
- Remove the additional text from the error message itself and instead
move that responsibility to the output formatter
- This makes sense, because this is not actually part of the error
condition, and it allows different display methods to adjust
the error output (e.g. include a log file if present, make the
link clickable, refer to another JIRA project if appropriate, etc.)
- Add the path to the log file that the reporter would ideally include
in the CLI package.
rose-m
approved these changes
Jul 28, 2021
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.
move that responsibility to the output formatter
condition, and it allows different display methods to adjust
the error output (e.g. include a log file if present, make the
link clickable, refer to another JIRA project if appropriate, etc.)
in the CLI package.