-
Notifications
You must be signed in to change notification settings - Fork 42
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
chore: Spellcheck and correct entire code base #887
Conversation
Force pushed to revert some whitespace changes to the manifest my editor automatically weaseled in there. I'll propose normalizing TOML formatting separately. |
It looks like PRs are configured to be squashed by default but rebase is an option. I suggest the split here is meaningful because in the event a later PR branched before this has a merge conflict or an API spelling problem comes up later, this split makes it easier to diagnose and re-correct (for the former scenario) or re-configure or upstream fixes (for the later scenario). |
Sorry for the delayed response. I had a rest and didn't look into PRs in recent days. First, it is great to integrate more great tools into workflow, and typos should be great and well-known one, so I'll proceed with merge it. I shall need to learn how I can configure typos locally at the same time.
We can rebase, but squash isn't bad, because we also have git revert and git cherry pick to help edit sub commits a PR conveniently. A key advantage of rebasing in my eyes is that if we do rebase, everyone can view and each of the three commit messages at the top level of the commit history. |
This is all the typos that `typos` is confident can just be fixed automatically, minus the overrides added to the manifest for the false positives I found.
These are ones `typos` was not confident on how to fix but these seem like reasonable resolutions to me.
45ac492
to
ffc031b
Compare
You shouldn't have to configure it at all, it will follow the project configs here. You don't even need it locally if you don't want. If you do, just run That's it.
This is not correct. If you squash, you do not have the ability to revert or cherry pick available any longer on the actual commits. Those tools only work at the commit level, and by definition if you squash the commits of a PR together you will no longer have them separately.
Yes, and it will turn up the most related commit message in a future |
I remember my friend fixed some typos by typos using his local typos plugin, #177.
This is what I would like to set up.
To be clear, we can revert/cherry pick them as long as we have references stored in .git, and they'll not be garbage collected in local under some conditions. They might be even forever stored on GitHub's storage, but I'm not sure whether we can pull these references from GitHub explicitly. But you're correct, this is not safe. |
I'm sure there are editor plugins and probably even LSP drivers for |
chore: Add typos configuration to manifest for project level spellchecking
This commit just sets the stage with tooling configuration for
typos
, conveniently tucked away in the workspace manifest where other lint configurations already are.chore: Fix typos throughout code base (automatic)
This commit has fixes for all the typos that
typos
is confident can just be fixed automatically, minus the overrides added to the manifest for the false positives I found.chore: Fix typos throughout code base (manual)
This commit has fixes for just the typos that
typos
was not confident on how to fix but these seem like reasonable resolutions to me.