Suggestion: Offer a solution in warning messages
dikarel opened this issue · 3 comments
The following warning message does not provide suggestions on how to fix the issue. I'm stuck not knowing how to fix the issue.
I think it'd be educational if there's a copy-pastable link somewhere in the CLI output pointing to a resource that provides:
- Examples on how to fix caught issues
- In-depth rationale behind the warning
If the solution is something trivial such as deleting the offending phrase, adding an instruction (e.g. "consider removing") to the warning message would make it unambiguous.
write-good doesn't like the word "additional". Maybe it's because I'm a non-native speaker but I have no idea what alternative it expects me to use that doesn't sound too informal. The "wordy or unneeded" messages in particular are very off-putting for the intended use case of "developer's who can't write good" -- if I knew how to write good, I wouldn't need write-good.
Oh, I'm also interested in the rationale behind the warnings/suggestions and a deeper explanation of what the "checks" mean.
I think this is a good idea, and PRs would be appreciated.