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

Revisit error messages to help users better #78

Open

MartinHelmut opened this issue Sep 29, 2022 · 0 comments

Labels

enhancement refactor

Milestone

Member

MartinHelmut commented Sep 29, 2022

Best to revisit all error messages and make them better. A good influence here can be Rust error messages, as described here: https://blog.rust-lang.org/2016/08/10/Shape-of-errors-to-come.html

Properties error messages need to fulfil:

Absolutely clear what the issue is for a human
Be specific where the issue is
If possible, how to fix the issue
Visually clarity
A stable error code (cannot change in future releases) to reference with more information

MartinHelmut added refactor enhancement labels

MartinHelmut added this to the Version 1 milestone

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment