Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add codespell support (config) and make it fix few typos #1364

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

yarikoptic
Copy link
Contributor

@yarikoptic yarikoptic commented Sep 4, 2024

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.

This is a reincarnated (no action this time) prior attempt

from a year ago, which shows that

  • new typos got detected (and/or introduced)
  • it is inconvenient to look for new typos without codespell config present so I had to copy it from that older PR
  • there is a typo in the model (superceded) which if already permeated to other places -- I guess ok to keep around , but otherwise ideally should have been fixed.

@xuanxu mentions

We want to keep the actions we have to mantain for the repo at a minimum, so prefer not to run codespell.

which is I guess ok, but is there another level of assistance/automation to look adding it to?

=== Do not change lines below ===
{
 "chain": [],
 "cmd": "codespell -w -i3 ./docs/editor_onboarding.md",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^
=== Do not change lines below ===
{
 "chain": [],
 "cmd": "codespell -w",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^
@sneakers-the-rat
Copy link
Contributor

This seems like a minimal maintenance burden thing, and since it is our publicly facing site (rather than correcting typos in code/comments that only programmers would see) it makes sense to me to have.

Maybe one thing that might ease anxiety around maintenance burden might be to scope it to just the parts of the package that contain public-facing strings like the erb templates? But then again there are probably some of those throughout the ruby and js too so maybe thats more complicated than it's worth.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants