feat: GitHub workflow Codespell#256
Conversation
Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>
Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>
Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>
| ) | ||
|
|
||
| type Conainer struct { | ||
| type Container struct { |
There was a problem hiding this comment.
I can revert this if this is going to cause an issue
| } | ||
|
|
||
| var containers []Conainer | ||
| var containers []Container |
There was a problem hiding this comment.
Looks like these are all contained in this file only so I don't expect to run into any issues.
nabuskey
left a comment
There was a problem hiding this comment.
I think it's nice that this catches and fixes typos (obviously we have a lot). Is it possible to exclude this check when determining if the PR passes overall checks?
There was a problem hiding this comment.
Is this necessary? I just don't want to introduce another thing to manage.
There was a problem hiding this comment.
This setup is useful for contributors to run pre-commit locally before raising a PR to check for any spelling errors. We don't need to maintain this file as it doesn't require any changes.
Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>
PR checks won't fail with the latest changes |
nabuskey
left a comment
There was a problem hiding this comment.
We have a lot of typos as shown by this PR and I think it's a good idea to have this. We should have this in the stacks repository as well. Especially when we move the examples directory to it.
Feature: Implement Codespell for Automatic Spell Checking
This pull request introduces a new GitHub workflow that leverages the Codespell tool to automatically check for spelling errors across our codebase.
Benefits:
How to Use:
pre-commit run -afrom the root folder. You may have to install pre-commit locally