doc: add Notation CLI Error Handling and Message Guideline #834
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
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. |
yizha1
reviewed
Dec 27, 2023
Contributor
yizha1
left a comment
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.
ghost
reviewed
Dec 27, 2023
ghost
reviewed
Dec 27, 2023
Member
Author
|
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. |
JeyJeyGao
reviewed
Jan 10, 2024
shizhMSFT
reviewed
Jan 30, 2024
|
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. |
JeyJeyGao
reviewed
Apr 9, 2024
Member
Author
|
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 <feynmanzhou@microsoft.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
priteshbandi
pushed a commit
that referenced
this pull request
May 28, 2024
This was referenced Jun 11, 2024
7h3-3mp7y-m4n
pushed a commit
to 7h3-3mp7y-m4n/notation
that referenced
this pull request
Mar 29, 2025
This error message improvement is based on the Notation CLI error message improvement guideline that we defined in notaryproject#834 Resolve part of notaryproject#934 Signed-off-by: Junjie Gao <junjiegao@microsoft.com>
7h3-3mp7y-m4n
pushed a commit
to 7h3-3mp7y-m4n/notation
that referenced
this pull request
Mar 29, 2025
…ject#834) Resolve notaryproject#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](https://hackmd.io/9O01p9xYS7S-8apWZkaLHg). --------- Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
FeynmanZhou
pushed a commit
to FeynmanZhou/notation
that referenced
this pull request
May 15, 2025
This error message improvement is based on the Notation CLI error message improvement guideline that we defined in notaryproject#834 Resolve part of notaryproject#934 Signed-off-by: Junjie Gao <junjiegao@microsoft.com>
FeynmanZhou
added a commit
to FeynmanZhou/notation
that referenced
this pull request
May 15, 2025
…ject#834) Resolve notaryproject#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](https://hackmd.io/9O01p9xYS7S-8apWZkaLHg). --------- Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 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.
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.