search

kubeshop / testkube

☸️ Kubernetes-native testing framework for test execution and orchestration
https://testkube.io
Other
1.32k stars 129 forks source link

Automatically detect capitalisation issues in docs contribs #3564

Open gberche-orange opened 1 year ago

gberche-orange commented 1 year ago

Why should it be implemented?

Manual feedback and timely fixes by @jfermi in https://github.com/kubeshop/testkube/pull/3538 are great

Automating detection of such capitalisation issues in PR tests could provide timely contributor feedback on expected capitalizations

Describe the improvement

PR checks include doc checks on expected capitalization for common words.

Potential functional inspiration in https://github.com/openservicebrokerapi/servicebroker/blob/master/tools/verify-all.sh in particular https://github.com/openservicebrokerapi/servicebroker/blob/b299b631ccca921c8c813a79eef672d782da0923/tools/verify-phrases.sh#L26-L42

Additional context Add any other context about the problem here if needed.

aabedraba commented 1 year ago

Super interesting! Thanks. I can look into it sometime.