Skip to content

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

@FeynmanZhou

Description

@FeynmanZhou

Is your feature request related to a problem?

The error messages in some Notation 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. Notation maintainers are working on improving some error messages, such as #810 .

What solution do you propose?

In order to provide clearer structures for error categorizing and also more actionable error outputs for better user experience, it is recommended to create a Notation CLI Error Handling Guideline.

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.

What alternatives have you considered?

NA

Any additional context?

No response

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Type

No type

Projects

Status

Done

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions