Skip to content

ci: add pre-commit config for codespell#147

Open
pixelatedkisses wants to merge 1 commit into
Vizonex:mainfrom
pixelatedkisses:add-pre-commit-config
Open

ci: add pre-commit config for codespell#147
pixelatedkisses wants to merge 1 commit into
Vizonex:mainfrom
pixelatedkisses:add-pre-commit-config

Conversation

@pixelatedkisses

@pixelatedkisses pixelatedkisses commented Jun 29, 2026

Copy link
Copy Markdown

What do these changes do?

This PR introduces a .pre-commit-config.yaml file at the root of the repository to automate formatting, and spell checking. It sets up:

  1. Standard hooks: trailing-whitespace and end-of-file-fixer to keep repository formatting consistently clean.
  2. codespell hook: To automatically catch typos in code and documentation before commits are finalized.
  3. An extensive inline --ignore-words-list and folder exclusion pattern.

Are there changes in behavior for the user?

This change is strictly restricted to the developer workflow and CI environment

Is it a substantial burden for the maintainers to support this?

No. It eliminates the need for maintainers to manually review and flag basic formatting errors during future PR reviews.

Related issue number

Relates to #144

Checklist

  • I think the code is well written
  • Unit tests for the changes exist
  • Documentation reflects the changes

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.

1 participant