Skip to content

It would be great to have a custom message on failure #8

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

Closed
j0tt opened this issue Oct 17, 2019 · 4 comments
Closed

It would be great to have a custom message on failure #8

j0tt opened this issue Oct 17, 2019 · 4 comments
Assignees

Comments

@j0tt
Copy link

j0tt commented Oct 17, 2019

Team loves this, but I get dms because it just says "validation failed". it would be nice to output the expected format.

@sumits-systango
Copy link
Contributor

Hey @j0tt
Thanks for the interest. Are you looking for a way to customise and configure the validation output message? What kind of messages formats are you thinking of?

@j0tt
Copy link
Author

j0tt commented Oct 25, 2019

For us it would be nice to have a customs output so we could say something like: “try something like [user story|task|bug] 34635: I did a good thing to this code”

We’re trying to not be too prescriptive with format and just make sure there’s an issue number and the issue type are in the message.

@MSFT-Chris-Barrett
Copy link

MSFT-Chris-Barrett commented Jan 21, 2020

+1 to having a custom message with an example of a valid format. Just being told "your PR title is wrong" leaves me at "okay, I need to change the PR title... does it need beachball emoji added to become valid?" For a silly, exagerrated example of how the open-ended message doesn't help lead a user to making a successful commit/PR request.

Edit: if there's a regex pattern being used to determine valid/invalid, could that pattern be written out in the error message? It may be a little human-unfriendly, but assuming most people reading the error message will be programmers, it's more helpful than no feedback.

sumits-systango added a commit that referenced this issue Apr 10, 2020
Improvement: It would be great to have a custom message on failure #8
@sumits-systango
Copy link
Contributor

This is done as part of release 2.2.0.

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

No branches or pull requests

3 participants