Add codespell support (config, workflow to detect/not fix) and make it fix few typos

selkies-project / selkies-gstreamer

Open-Source Low-Latency Accelerated Linux WebRTC HTML5 Remote Desktop Streaming Platform for Self-Hosting, Containers, Kubernetes, or Cloud/HPC

https://selkies-project.github.io/selkies-gstreamer/

Mozilla Public License 2.0

381 stars 49 forks source link

Add codespell support (config, workflow to detect/not fix) and make it fix few typos #162

Closed yarikoptic closed 4 months ago

yarikoptic commented 4 months ago

More about codespell: https://github.com/codespell-project/codespell .

I personally introduced it to dozens if not hundreds of projects already and so far only positive feedback.

CI workflow has 'permissions' set only to 'read' so also should be safe.

ehfd commented 4 months ago

Thanks for your recommendation, and I'm putting information about this on the development.md style guide as a recommended procedure for contributions.

However, it seems that codespell is not 100% accurate at all times, requiring manual approval, and since it's going to have read permissions only, I would prefer to leave it for individual developers to run in their pull requests instead of the CI.

ehfd commented 4 months ago

I've fixed all the typos thanks to your PR and added adequate instructions about using codespell for developers. Because I'd like to constrain CI/CD pipelines to those that are automatic, I'll postpone the PR which adds the CI for now.