tag-security icon indicating copy to clipboard operation
tag-security copied to clipboard

[Suggestion] provide suggested fix for cSpell errors

Open ultrasaurus opened this issue 4 years ago • 3 comments
trafficstars

Description: add helpful error message for spelling lint errors

Impact: speed up PR review/resolution by teaching contributors to fish!

Scope: I would expect it to take a few hours for someone with pretty good bash skills

Additional info:

  • https://github.com/cncf/tag-security/issues/311

Suggestion: suppose the linter caught "darkmode" and "foobar" then we could include a message like:

If the errors are names, external links, or unusual, but accurate technical words, 
then you should create an inline comment like:
<!-- cSpell:ignore darkmode foobar -->
of course, you should only include non-dictionary words that are correctly spelled!

If the error happens because of a common technical term or proper name that is likely
to appear many times, then please edit "ci/spelling-config.json"
```

ultrasaurus avatar Jul 01 '21 21:07 ultrasaurus

Another instance to consider: https://github.com/cncf/tag-security/pull/717

lumjjb avatar Jul 14 '21 18:07 lumjjb

Hey!! Can I be of any help?

sayantani11 avatar Aug 30 '21 11:08 sayantani11

This issue has been automatically marked as inactive because it has not had recent activity.

stale[bot] avatar Oct 29 '21 12:10 stale[bot]