Skip to content

doc (spec): add error message guideline#1163

Merged
TerryHowe merged 52 commits into
oras-project:mainfrom
FeynmanZhou:error-guide
Feb 23, 2024
Merged

doc (spec): add error message guideline#1163
TerryHowe merged 52 commits into
oras-project:mainfrom
FeynmanZhou:error-guide

Conversation

@FeynmanZhou

Copy link
Copy Markdown
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
Copy Markdown
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

codecov-commenter commented Nov 10, 2023

Copy link
Copy Markdown

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
Copy Markdown
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.

@FeynmanZhou FeynmanZhou marked this pull request as ready for review November 10, 2023 01:56
@sajayantony

Copy link
Copy Markdown
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>
Comment thread docs/proposals/error-handling-guideline.md Outdated
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
@FeynmanZhou FeynmanZhou requested a review from shizhMSFT January 4, 2024 11:11
Comment thread docs/proposals/error-handling-guideline.md Outdated
Comment thread docs/proposals/error-handling-guideline.md Outdated
Comment thread docs/proposals/error-handling-guideline.md Outdated
Comment thread docs/proposals/error-handling-guideline.md Outdated
Comment thread docs/proposals/error-handling-guideline.md Outdated
Comment thread docs/proposals/error-handling-guideline.md Outdated
Comment thread docs/proposals/error-handling-guideline.md Outdated
Comment thread docs/proposals/error-handling-guideline.md Outdated

@shizhMSFT shizhMSFT left a comment

Copy link
Copy Markdown
Contributor

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>
@FeynmanZhou FeynmanZhou requested a review from qweeah January 9, 2024 04:21
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>

@qweeah qweeah left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

Comment thread docs/proposals/error-handling-guideline.md Outdated
Co-authored-by: Billy Zha <qweeah@gmail.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>

@TerryHowe TerryHowe left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

@FeynmanZhou

Copy link
Copy Markdown
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
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