Skip to content

feature: Add codespell check#204

Merged
pedrominatel merged 1 commit intoespressif:mainfrom
0cici:feature/add_codespell
Jan 23, 2026
Merged

feature: Add codespell check#204
pedrominatel merged 1 commit intoespressif:mainfrom
0cici:feature/add_codespell

Conversation

@0cici
Copy link
Contributor

@0cici 0cici commented Jan 20, 2026

Description

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.

@0cici
Copy link
Contributor Author

0cici commented Jan 22, 2026

Hi @pedrominatel, I tried to add codepell to CI as a pre-commit check, but there is no job running. Pls take a look. Thank you!

@pedrominatel
Copy link
Member

Hi @pedrominatel, I tried to add codepell to CI as a pre-commit check, but there is no job running. Pls take a look. Thank you!

I had to run manually.

@0cici
Copy link
Contributor Author

0cici commented Jan 23, 2026

Hi @pedrominatel, I tried to add codepell to CI as a pre-commit check, but there is no job running. Pls take a look. Thank you!

I had to run manually.

Thank you! Now the codespell check passed successfully and no typos are found.
cc: @Shen7436 Pls help review. Thx!

@0cici 0cici closed this Jan 23, 2026
@0cici 0cici reopened this Jan 23, 2026
@Shen7436
Copy link

Hi @pedrominatel, I tried to add codepell to CI as a pre-commit check, but there is no job running. Pls take a look. Thank you!

I had to run manually.

Thank you! Now the codespell check passed successfully and no typos are found. cc: @Shen7436 Pls help review. Thx!

Hi @0cici LGTM!

@0cici
Copy link
Contributor Author

0cici commented Jan 23, 2026

Hi @pedrominatel, pls help review and merge it if everything looks good~

@pedrominatel pedrominatel merged commit 89d6fd5 into espressif:main Jan 23, 2026
2 checks passed
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.

3 participants