doc: add Notation CLI Error Handling and Message Guideline #834
Conversation
FeynmanZhou
requested review from
gokarnm,
JeyJeyGao,
justincormack,
NiazFK,
priteshbandi,
rgnote,
shizhMSFT,
SteveLasker and
Two-Hearts
as code owners
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.
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.
|
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. |
FeynmanZhou
force-pushed
the
error-msg
branch
2 times, most recently
from
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]>
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]>
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.