Add codespell support (config, workflow to detect/not fix) and make it fix some typos #95
Conversation
…os automagically
=== Do not change lines below ===
{
"chain": [],
"cmd": "codespell -w",
"exit": 0,
"extra_inputs": [],
"inputs": [],
"outputs": [],
"pwd": "."
}
^^^ Do not change lines above ^^^
|
Hello Dr. Yarik! Thanks of looking at the project and finding our typos. We will need to send you a CLA to sign as part of the policy since this is your first submission to the MathWorks github organization. I will reach out by email to handle that. Sorry for the delay. |
|
Thanks for the contribution. Could you please message me, and I will initiate the CLA procedure? Thank you! |
|
Sorry @nothans , but message how? I do not think there is a messaging system on github but I could be wrong. |
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - name: Checkout |
There was a problem hiding this comment.
More of a question about how the tool works than any feedback: does the tool run statically or send data to a service?
There was a problem hiding this comment.
AFAIK just runs statically and nothing is sent AFAIK, I didn't spot any use of requests or urllib library in it,
| jobs: | ||
| codespell: | ||
| name: Check for spelling errors | ||
| runs-on: ubuntu-latest |
There was a problem hiding this comment.
Ubuntu is probably fine, just thinking about smaller distros like alpine.
| skip = .git*,.codespellrc | ||
| check-hidden = true | ||
| # ignore-regex = | ||
| ignore-words-list = ans |
There was a problem hiding this comment.
really surprised this is the only ignore word 👍
There was a problem hiding this comment.
the tool is quite robust! ;)
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.
just a few typos (well done!) so benefit is small overall.