-
Notifications
You must be signed in to change notification settings - Fork 84
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
doc: add Notation CLI Error Handling and Message Guideline #834
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #834 +/- ##
==========================================
+ Coverage 64.09% 71.27% +7.17%
==========================================
Files 40 45 +5
Lines 2284 2169 -115
==========================================
+ Hits 1464 1546 +82
+ Misses 698 429 -269
- Partials 122 194 +72 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, @FeynmanZhou While we may not provide an exhaustive list of examples in this guide, I would suggest this PR provides a general guideline. We can create another issue to track improvements for each command.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
I will move all suggested changes for those examples into different GitHub issues. All comments above are related to examples so I will address them in separate issues. But I will mark those comments as resolved first. |
This PR is stale because it has been opened for 45 days with no activity. Remove stale label or comment. Otherwise, it will be closed in 30 days. |
I am curious why this doc PR broken the Codecov? It doesn't have any code change. |
1cf0556
to
ca096da
Compare
Signed-off-by: Feynman Zhou <[email protected]>
Signed-off-by: Feynman Zhou <[email protected]>
Signed-off-by: Feynman Zhou <[email protected]>
Signed-off-by: Feynman Zhou <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
This error message improvement is based on the Notation CLI error message improvement guideline that we defined in #834 Resolve part of #934 Signed-off-by: Junjie Gao <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Resolve #824
This guideline only includes the guiding principles for Notation CLI error message. All suggested changes will be documented into different GitHub issues and another document.