roadmap icon indicating copy to clipboard operation
roadmap copied to clipboard

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

Open yarikoptic opened this issue 8 months ago • 2 comments

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.

Inspired by initial attempt in

  • https://github.com/CDLUC3/dmptool/pull/428

while listening to a presentation about dmptool.org .

yarikoptic avatar Apr 21 '25 17:04 yarikoptic

Hi yarikoptic, thank you for the PR. :) This is interesting and could prove to be useful for us. I suppose the renaming of variables and existing strings could pose issues though. I might point this at the our development branch and revert the actual code changes if I end up approving. Hope that's all okay and thank you again.

aaronskiba avatar Apr 30 '25 16:04 aaronskiba

just to make clear: do you want me to rebase/redo these fixes on top of development branch instead?

as for variables names etc -- we could whitelist them or annotate inline if only few specific lines, see https://github.com/codespell-project/codespell?tab=readme-ov-file#inline-ignore . Please point which ones you would like?

yarikoptic avatar Apr 30 '25 19:04 yarikoptic