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.

Sign up for GitHub

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

Jump to bottom

doc: add Notation CLI Error Handling and Message Guideline #834

Merged
merged 4 commits into from
May 28, 2024
Merged

doc: add Notation CLI Error Handling and Message Guideline #834

merged 4 commits into from
May 28, 2024

Conversation

FeynmanZhou
Copy link
Member

@FeynmanZhou FeynmanZhou commented Nov 20, 2023 •
edited
Loading

Resolve #824

This guideline only includes the guiding principles for Notation CLI error message. All suggested changes will be documented into different GitHub issues and another document.

@FeynmanZhou FeynmanZhou marked this pull request as draft November 20, 2023 09:34
@codecov-commenter
Copy link

codecov-commenter commented Nov 20, 2023 •
edited by codecov bot
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 71.27%. Comparing base (31c9e84) to head (a0fe8af).
Report is 81 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main     #834      +/-   ##
==========================================
+ Coverage   64.09%   71.27%   +7.17%     
==========================================
  Files          40       45       +5     
  Lines        2284     2169     -115     
==========================================
+ Hits         1464     1546      +82     
+ Misses        698      429     -269     
- Partials      122      194      +72

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

@FeynmanZhou FeynmanZhou marked this pull request as ready for review December 13, 2023 07:49
yizha1
yizha1 reviewed Dec 27, 2023
View reviewed changes
Copy link
Contributor

@yizha1 yizha1 left a comment

Choose a reason for hiding this comment

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

Thanks, @FeynmanZhou While we may not provide an exhaustive list of examples in this guide, I would suggest this PR provides a general guideline. We can create another issue to track improvements for each command.

specs/error-handling-guideline.md Outdated Show resolved Hide resolved
specs/error-handling-guideline.md Outdated Show resolved Hide resolved
specs/error-handling-guideline.md Outdated Show resolved Hide resolved
specs/error-handling-guideline.md Outdated Show resolved Hide resolved
Two-Hearts
Two-Hearts reviewed Dec 27, 2023
View reviewed changes
specs/error-handling-guideline.md Outdated Show resolved Hide resolved
specs/error-handling-guideline.md Outdated Show resolved Hide resolved
Two-Hearts
Two-Hearts previously approved these changes Jan 9, 2024
View reviewed changes
Copy link
Contributor

@Two-Hearts Two-Hearts 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

I will move all suggested changes for those examples into different GitHub issues. All comments above are related to examples so I will address them in separate issues. But I will mark those comments as resolved first.

priteshbandi
priteshbandi reviewed Jan 24, 2024
View reviewed changes
specs/error-handling-guideline.md Outdated Show resolved Hide resolved
specs/error-handling-guideline.md Outdated Show resolved Hide resolved
shizhMSFT
shizhMSFT reviewed Jan 30, 2024
View reviewed changes
specs/error-handling-guideline.md Outdated Show resolved Hide resolved
specs/error-handling-guideline.md Outdated Show resolved Hide resolved
specs/error-handling-guideline.md Outdated Show resolved Hide resolved
specs/error-handling-guideline.md Outdated Show resolved Hide resolved
specs/error-handling-guideline.md Outdated Show resolved Hide resolved
specs/error-handling-guideline.md Outdated Show resolved Hide resolved
@github-actions GitHub Actions
Copy link

This PR is stale because it has been opened for 45 days with no activity. Remove stale label or comment. Otherwise, it will be closed in 30 days.

@github-actions github-actions bot added the Stale label Mar 22, 2024
@yizha1 yizha1 removed the Stale label Mar 22, 2024
@yizha1 yizha1 added this to the 1.2.0 milestone Mar 22, 2024
JeyJeyGao
JeyJeyGao reviewed Apr 9, 2024
View reviewed changes
specs/error-handling-guideline.md Outdated Show resolved Hide resolved
specs/error-handling-guideline.md Show resolved Hide resolved
@FeynmanZhou FeynmanZhou mentioned this pull request Apr 12, 2024
Open
@FeynmanZhou FeynmanZhou mentioned this pull request Apr 26, 2024
Open
@JeyJeyGao JeyJeyGao mentioned this pull request Apr 26, 2024
Merged
@FeynmanZhou
Copy link
Member Author

I am curious why this doc PR broken the Codecov? It doesn't have any code change.

@yizha1 yizha1 mentioned this pull request May 20, 2024
Open
@FeynmanZhou FeynmanZhou force-pushed the error-msg branch 2 times, most recently from 1cf0556 to ca096da Compare May 27, 2024 10:23
@FeynmanZhou
add Notation CLI Error Handling and Message Guideline
cbd2d9f 
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
@FeynmanZhou
rebase the branch
fa06436 
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
@FeynmanZhou
resolve conflicts
b330023 
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
@FeynmanZhou
refresh GPG key
a0fe8af 
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
JeyJeyGao
JeyJeyGao approved these changes May 28, 2024
View reviewed changes
Copy link
Contributor

@JeyJeyGao JeyJeyGao left a comment

Choose a reason for hiding this comment

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

LGTM

Two-Hearts
Two-Hearts approved these changes May 28, 2024
View reviewed changes
Copy link
Contributor

@Two-Hearts Two-Hearts left a comment

Choose a reason for hiding this comment

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

LGTM

priteshbandi pushed a commit that referenced this pull request May 28, 2024
@JeyJeyGao
fix: error message for trust policy (#933)
d439bbb 
This error message improvement is based on the Notation CLI error message improvement guideline that we defined in #834

Resolve part of #934 
Signed-off-by: Junjie Gao <junjiegao@microsoft.com>
priteshbandi
priteshbandi approved these changes May 28, 2024
View reviewed changes
Copy link
Contributor

@priteshbandi priteshbandi left a comment

Choose a reason for hiding this comment

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

LGTM

@priteshbandi priteshbandi merged commit 66126e2 into notaryproject:main May 28, 2024
7 checks passed
This was referenced Jun 11, 2024
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@priteshbandi priteshbandi priteshbandi approved these changes

@JeyJeyGao JeyJeyGao JeyJeyGao approved these changes

@Two-Hearts Two-Hearts Two-Hearts approved these changes

@gokarnm gokarnm Awaiting requested review from gokarnm gokarnm is a code owner

@justincormack justincormack Awaiting requested review from justincormack

@NiazFK NiazFK Awaiting requested review from NiazFK NiazFK is a code owner

@rgnote rgnote Awaiting requested review from rgnote rgnote is a code owner

@SteveLasker SteveLasker Awaiting requested review from SteveLasker

@yizha1 yizha1 Awaiting requested review from yizha1 yizha1 is a code owner

@toddysm toddysm Awaiting requested review from toddysm toddysm is a code owner

@vaninrao10 vaninrao10 Awaiting requested review from vaninrao10 vaninrao10 is a code owner

@shizhMSFT shizhMSFT Awaiting requested review from shizhMSFT shizhMSFT is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
1.2.0
Development

Successfully merging this pull request may close these issues.

Create a CLI Error Handling Guideline to improve error messages and error handling
7 participants
@FeynmanZhou @codecov-commenter @priteshbandi @shizhMSFT @JeyJeyGao @yizha1 @Two-Hearts