Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(ci): add 'typos' check #317

Merged
merged 8 commits into from
Oct 19, 2023
Merged

feat(ci): add 'typos' check #317

merged 8 commits into from
Oct 19, 2023

Conversation

woshilapin
Copy link
Contributor

@woshilapin woshilapin commented Oct 15, 2023

resolves #311

Description

Will catch most of the typos in the documentation and markdown files automatically in CI (see #311 for details). Note that I chose to not create a new job and make it part of the check job (but I can go either way).

Also, I configured typos to ignore a bunch of 7-chars commit hash and one of your other project halp (which obviously is a typo of help 🙃).

Motivation and Context

See #311.

How Has This Been Tested?

CI will tell.

Types of Changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation (no code change)
  • Refactor (refactoring production code)
  • Other - CI improvement

Checklist:

  • My code follows the code style of this project.
  • I have updated the documentation accordingly.
  • I have formatted the code with rustfmt.
  • I checked the lints with clippy.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • Needs docs(changelog): fix typos #316 to be merged first

@codecov-commenter
Copy link

Codecov Report

All modified lines are covered by tests ✅

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

📢 Thoughts on this report? Let us know!.

.github/workflows/ci.yml Outdated Show resolved Hide resolved
@orhun orhun changed the title ci(typos): add 'typos' check feat(ci): add 'typos' check Oct 19, 2023
@orhun orhun merged commit 88c34ab into orhun:main Oct 19, 2023
23 of 24 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.

Check typos via CI
3 participants