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

[ci] add codespell #488

Closed
jameslamb opened this issue Jan 6, 2025 · 0 comments · Fixed by #489
Closed

[ci] add codespell #488

jameslamb opened this issue Jan 6, 2025 · 0 comments · Fixed by #489
Labels
build/test Building and testing the documentation good first issue Good for newcomers

Comments

@jameslamb
Copy link
Member

Description

The codespell project can be used to identify common English spelling mistakes in text files. It should be added in CI here.

Benefits of this work

  • fixes and prevents typos, which improves search and removes distractions for readers

Acceptance Criteria

  • every commit merged to main passes codespell checks

Approach

Add it to .pre-commit-config.yaml, with a block similar to this:

  - repo: https://github.com/codespell-project/codespell
    rev: v2.3.0
    hooks:
      - id: codespell
        additional_dependencies: [tomli]
        args: ["--toml", "pyproject.toml"]

Add any relevant configuration in pyproject.toml. Example from rmm: https://github.com/rapidsai/rmm/blob/b4c43c5fd03cf93fd935343a4e8b2ccfa763afdb/pyproject.toml#L3-L11

And run like this:

pre-commit run --all-files

Notes

N/A

@jameslamb jameslamb added build/test Building and testing the documentation good first issue Good for newcomers labels Jan 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build/test Building and testing the documentation good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant