Revisit error messages to help users better - Githubissues

krieselreihe / litr

Litr (Language Independent Task Runner) lets you configure and then run any tasks you want for any language.

MIT License

8 stars 0 forks source link

Revisit error messages to help users better #78

Open MartinHelmut opened 2 years ago

MartinHelmut commented 2 years ago

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