Skip to content

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

@FeynmanZhou

Description

@FeynmanZhou

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions