notaryproject / notation

A CLI tool to sign and verify artifacts
https://notaryproject.dev/
Apache License 2.0
306 stars 84 forks source link

doc: add Notation CLI Error Handling and Message Guideline #834

Closed FeynmanZhou closed 1 month ago

FeynmanZhou commented 7 months ago

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.

codecov-commenter commented 7 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 71.27%. Comparing base (31c9e84) to head (a0fe8af). Report is 81 commits behind head on main.

Additional details and impacted files ```diff @@ 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 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

FeynmanZhou commented 5 months ago

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.

github-actions[bot] commented 3 months ago

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.

FeynmanZhou commented 1 month ago

I am curious why this doc PR broken the Codecov? It doesn't have any code change.