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

Create a CLI Error Handling Guideline to improve error messages and error handling #1158

Closed
1 task done
FeynmanZhou opened this issue Nov 1, 2023 · 0 comments · Fixed by #1163
Closed
1 task done
Labels
enhancement New feature or request
Milestone

Comments

@FeynmanZhou
Copy link
Member

FeynmanZhou commented Nov 1, 2023

What is the version of your ORAS CLI

1.1.0

What would you like to be added?

The error messages in some ORAS CLI commands do not show the actual value that were provided or show too vague error messages that are hard to troubleshoot and locate the root cause. ORAS maintainers are working on improving some error messages, such as #1152 , #1156 , #1169 .

In order to provide clearer structures for error categorizing and also more actionable error outputs for better user experience, we need to create an ORAS CLI Error Handling Guideline.

Why is this needed for ORAS?

This document aims to provide the guidelines for ORAS contributors to improve existing error messages and handling method as well as the new error output format. It will also provide recommendations for ORAS CLI contributors for how to write friendly and standard error messages and avoid inconsistent error handling & messages.

Are you willing to submit PRs to contribute to this feature?

  • Yes, I am willing to implement it.
@FeynmanZhou FeynmanZhou added the enhancement New feature or request label Nov 1, 2023
@FeynmanZhou FeynmanZhou added this to the v1.2.0 milestone Nov 1, 2023
@FeynmanZhou FeynmanZhou added triage New issues or PRs to be acknowledged by maintainers and removed triage New issues or PRs to be acknowledged by maintainers labels Nov 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Development

Successfully merging a pull request may close this issue.

1 participant