Support for automatic spell-checking - Githubissues

kreuzwerker / terraform-provider-docker

Terraform Docker provider

Mozilla Public License 2.0

570 stars 187 forks source link

Support for automatic spell-checking #589

Open vszabo2 opened 7 months ago

vszabo2 commented 7 months ago

Community Note

Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
Please do not leave "+1" or "me too" comments, they generate extra noise for issue followers and do not help prioritize the request
If you are interested in working on this issue or have submitted a pull request, please leave a comment

Description

Currently, the project uses github.com/client9/misspell/cmd/misspell to spell-check the documentation. This only flags "commonly misspelled English words." Many not-so-common misspellings have slipped through the cracks (https://github.com/kreuzwerker/terraform-provider-docker/pulls?q=spelling). I propose changing the Makefile to use a more robust spell-checker.