Skip to content
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 (spec): add error message guideline #1163

Merged
merged 52 commits into from
Feb 23, 2024

Conversation

FeynmanZhou
Copy link
Member

What this PR does / why we need it:

add CLI error handling guide

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #1158

Please check the following list:

  • Does the affected code have corresponding tests, e.g. unit test, E2E test?
  • Does this change require a documentation update?
  • Does this introduce breaking changes that would require an announcement or bumping the major version?
  • Do all new files have an appropriate license header?

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>
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>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
@TerryHowe
Copy link
Member

Are we going to link this file from https://oras.land/docs/community/developer_guide

Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
@codecov-commenter
Copy link

codecov-commenter commented Nov 10, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.92%. Comparing base (ea36d48) to head (d338fce).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1163   +/-   ##
=======================================
  Coverage   81.92%   81.92%           
=======================================
  Files          83       83           
  Lines        3995     3995           
=======================================
  Hits         3273     3273           
  Misses        499      499           
  Partials      223      223           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
@FeynmanZhou
Copy link
Member Author

Are we going to link this file from https://oras.land/docs/community/developer_guide

Yes. We could add this doc link to that guide after it is merged.

@sajayantony
Copy link
Contributor

The examples and patterns are really helpful @FeynmanZhou. Thanks for putting this together.

@qweeah qweeah changed the title add error message guideline doc: add error message guideline Nov 10, 2023
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Copy link
Contributor

@shizhMSFT shizhMSFT left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Copy link
Contributor

@qweeah qweeah left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Co-authored-by: Billy Zha <qweeah@gmail.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Copy link
Member

@TerryHowe TerryHowe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@FeynmanZhou
Copy link
Member Author

@oras-project/oras-cli Are we good to merge this PR now?

@TerryHowe TerryHowe merged commit 486729a into oras-project:main Feb 23, 2024
7 checks passed
FeynmanZhou added a commit to FeynmanZhou/oras that referenced this pull request May 11, 2024
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Co-authored-by: Billy Zha <jinzha1@microsoft.com>
Co-authored-by: Billy Zha <qweeah@gmail.com>
Co-authored-by: Terry Howe <tlhowe@amazon.com>
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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create a CLI Error Handling Guideline to improve error messages and error handling
8 participants