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

Offer a corrective recommendation when a check has a warning or error #25

Open
danielbachhuber opened this issue Sep 2, 2016 · 4 comments

Comments

@danielbachhuber
Copy link
Member

danielbachhuber commented Sep 2, 2016

When a check has a warning or an error, we should offer a corrective recommendation on what they should do to try to address the issue.

@danielbachhuber danielbachhuber changed the title Offer a corrective suggestion when a check has a warning or error Offer a corrective recommendation when a check has a warning or error Sep 2, 2016
@danielbachhuber
Copy link
Member Author

For instance, "Files detected with different MIME type" as an error message would be more helpful if it indicated which files had incorrect extensions and how to resolve the error.

@ibertrix
Copy link

Maybe it can be added an option verbose giving more information?

@davegaeddert
Copy link
Contributor

davegaeddert commented Nov 10, 2017

@danielbachhuber do you have any specific ideas about how you'd like to see this implemented? What if another field (recommendation, explanation, suggestions or something) was added that isn't enabled by default but can be by using the --fields option? I'm guessing some of the text could get pretty long.

@danielbachhuber
Copy link
Member Author

What if another field (recommendation, explanation, suggestions or something) was added that isn't enabled by default but can be by using the --fields option?

Yes, this is what I was thinking. We should keep recommendations relatively concise, but we can always link to supplemental documentation.

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

No branches or pull requests

3 participants