exercism / exercism/configlet

lint: Error/warning messages should be instructive

Open
#160 0 comments 0 reactions 0 assignees View on GitHub
cmd: lint kind: feature
Dominant language
Nim
Stars
23
Forks
17
Avg merge
13h 57m
Merged PRs (30d)
1

Description

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

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.