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.

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

lint: Error/warning messages should be instructive #160

Open
ErikSchierboom opened this issue Jan 29, 2021 · 0 comments
Open

lint: Error/warning messages should be instructive #160

ErikSchierboom opened this issue Jan 29, 2021 · 0 comments
Labels
cmd: lint kind: feature User-facing enhancement

Comments

@ErikSchierboom
Copy link
Member

With the linting functionality it is key that the error/warning messages we produce be as instructive to the user as possible. This means that the message should:

  1. Explain why the error/warning is occuring
  2. Explain what must be done to fix it
  3. Give as much context as possible. So not "JSON array is empty", but instead "The concepts array in the config.json file must contain at least one concept`
  4. Link to the documentation where the rule is defined
@ee7 ee7 changed the title Error/warning messages should be instructive lint: Error/warning messages should be instructive May 9, 2021
@ee7 ee7 added cmd: lint kind: feature User-facing enhancement labels May 10, 2021
@ErikSchierboom ErikSchierboom added this to To do in configlet 4.0.0 via automation Feb 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cmd: lint kind: feature User-facing enhancement
Projects
Status: No status
Development

No branches or pull requests

2 participants