Skip to content

Add codespell support (config, workflow to detect/not fix) and make it fix some typos#1072

Open
yarikoptic wants to merge 3 commits into
github:mainfrom
yarikoptic:enh-codespell
Open

Add codespell support (config, workflow to detect/not fix) and make it fix some typos#1072
yarikoptic wants to merge 3 commits into
github:mainfrom
yarikoptic:enh-codespell

Conversation

@yarikoptic

Copy link
Copy Markdown

More about codespell: https://github.com/codespell-project/codespell .

I personally introduced it to dozens if not hundreds of projects already and so far only positive feedback.

CI workflow has 'permissions' set only to 'read' so also should be safe.

…nteractively

=== Do not change lines below ===
{
 "chain": [],
 "cmd": "codespell -w -i 3 -C 4",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^
@yarikoptic yarikoptic requested a review from a team as a code owner September 9, 2025 18:43
Copilot AI review requested due to automatic review settings September 9, 2025 18:43

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR introduces codespell support to the project to automatically detect spelling errors in the codebase. The changes add a configuration file for codespell settings and a GitHub Actions workflow to run spell checks on pushes and pull requests.

  • Adds codespell configuration with appropriate exclusions for git files and checksums
  • Creates a GitHub Actions workflow to run codespell checks with read-only permissions
  • Fixes existing typos found in comment headers (correcting "Ths" to "The")

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File Description
.codespellrc Configuration file defining codespell behavior and exclusions
.github/workflows/codespell.yml GitHub Actions workflow to run spell checks on CI
internal/githubv4mock/query.go Fixes typo in comment header
internal/githubv4mock/local_round_tripper.go Fixes typo in comment header

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@osamamaamon1-jpg

osamamaamon1-jpg commented Sep 18, 2025 via email

Copy link
Copy Markdown
@yarikoptic

Copy link
Copy Markdown
Author

seems was approved, but never merged and CI seems stuck? I wonder what if anything to be done here?

@SamMorrowDrums

Copy link
Copy Markdown
Collaborator

@yarikoptic it wasn't approved by anyone on the actual team, we will get back to it. Thanks for the contribution.

@github-actions github-actions Bot added the stale label Jun 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

5 participants