You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This PR added codespell check to this repository. Codespell will be implemented in two ways:
as a local pre-commit hook.
as a CI job in GitLab/GitHub workflows.
Related
Closes DOC-13429
Testing
In the local PC, install pre-commit by running pip install pre-commit and activate the pre-commit hook by running pre-commit install. Then when you commit changes, the hook will do the check. Based on the recent configuration, it will exclude some folders/files from the check, such as *.png, 3dmodels/espressif.3dshapes, and footprints/Espressif.pretty.
Another simple way is to navigate to the target directory, such as symbols/Espressif.kicad_sym, and then run codepell . to enable the check for the specific file.
Checklist
Before submitting a Pull Request, please ensure the following:
🚨 This PR does not introduce breaking changes.
All CI checks (GH Actions) pass.
Documentation is updated as needed.
Tests are updated or added as necessary.
Code is well-commented, especially in complex areas.
Git history is clean — commits are squashed to the minimum necessary.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR added codespell check to this repository. Codespell will be implemented in two ways:
Related
Closes DOC-13429
Testing
In the local PC, install
pre-commitby runningpip install pre-commitand activate the pre-commit hook by runningpre-commit install. Then when you commit changes, the hook will do the check. Based on the recent configuration, it will exclude some folders/files from the check, such as *.png, 3dmodels/espressif.3dshapes, and footprints/Espressif.pretty.Another simple way is to navigate to the target directory, such as
symbols/Espressif.kicad_sym, and then runcodepell .to enable the check for the specific file.Checklist
Before submitting a Pull Request, please ensure the following: