Skip to content

ci: add codespell document check#136

Merged
leeebo merged 3 commits into
espressif:masterfrom
skywxFang:add-codespell-doc-check
Jun 4, 2026
Merged

ci: add codespell document check#136
leeebo merged 3 commits into
espressif:masterfrom
skywxFang:add-codespell-doc-check

Conversation

@skywxFang

@skywxFang skywxFang commented May 19, 2026

Copy link
Copy Markdown
Contributor

Description

Add a pre-commit based codespell workflow for documentation files and fix existing spelling issues in docs.

Testing

Here are the workflow examples:

Workflow fails when a new typo is introduced
Workflow passes after the typo is fixed


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.

skywxFang added 3 commits May 19, 2026 17:31
Add a pre-commit based codespell workflow for documentation files and fix existing spelling issues in docs.
@skywxFang

Copy link
Copy Markdown
Contributor Author

Hi @Shen7436, PTAL. Here are the workflow examples:

@Shen7436

Shen7436 commented Jun 2, 2026

Copy link
Copy Markdown

Hi @Shen7436, PTAL. Here are the workflow examples:

Hi @skywxFang The update LGTM! Thanks for you effort. I have no further comments :)

@skywxFang

Copy link
Copy Markdown
Contributor Author

Hi @leeebo PTAL, thanks!

@leeebo

leeebo commented Jun 4, 2026

Copy link
Copy Markdown
Collaborator

@skywxFang LGTM, Thanks!

@leeebo leeebo merged commit db0f656 into espressif:master Jun 4, 2026
1 check 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