Skip to content

Add codespell CI workflow for automated spelling checks#645

Merged
aaronpowell merged 4 commits intomainfrom
copilot/fix-spelling-grammar-issues
Feb 3, 2026
Merged

Add codespell CI workflow for automated spelling checks#645
aaronpowell merged 4 commits intomainfrom
copilot/fix-spelling-grammar-issues

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Feb 2, 2026

Pull Request Checklist

  • I have read and followed the CONTRIBUTING.md guidelines.
  • My contribution adds a new instruction, prompt, agent, or skill file in the correct directory.
  • The file follows the required naming convention.
  • The content is clearly structured and follows the example format.
  • I have tested my instructions, prompt, agent, or skill with GitHub Copilot.
  • I have run npm start and verified that README.md is up to date.

Description

Implements automated spelling checks in CI using codespell to catch typos before merge.

Workflow (.github/workflows/codespell.yml):

  • Runs on pushes to main and all PRs
  • Uses codespell-project/actions-codespell@v2
  • Checks file contents and filenames

Configuration (.codespellrc):

  • Ignores intentional example typos (e.g., Line Numer in add-educational-comments.prompt.md)
  • Whitelists technical terms: AKS, EDN, rouge, categor (TS template literal), ative (Declarative), afterall, deques
  • Skips generated artifacts: node_modules, package-lock.json, website builds

Spelling Fixes:

  • Fixed spelling error in .github/copilot-instructions.md: "formated" → "formatted"

Verified locally: catches real errors (seperateseparate, formatedformatted), ignores whitelisted terms, zero false positives on current codebase.


Type of Contribution

  • New instruction file.
  • New prompt file.
  • New agent file.
  • New collection file.
  • New skill file.
  • Update to existing instruction, prompt, agent, collection or skill.
  • Other (please specify): CI workflow addition and spelling fix

Additional Notes

Addresses request to add regular spelling checks to CI. Spelling errors from PR #639 were already fixed; this adds automation to prevent future issues. The CI workflow successfully detected and we fixed a spelling error in .github/copilot-instructions.md that was introduced in the repository.


By submitting this pull request, I confirm that my contribution abides by the Code of Conduct and will be licensed under the MIT License.

Original prompt

This section details on the original issue you should resolve

<issue_title>Spelling and grammar auto-check</issue_title>
<issue_description>Below is a list of spelling issues that were detected by running codespell on this repo:

File Line Text Issue Suggested correction
instructions/oqtane.instructions.md 34 "Each action in the client module is a seperate razor file that inherits from ModuleBase with index.razor being the default action." Misspelling of "separate" Replace "seperate" with "separate"
instructions/oqtane.instructions.md 66 "Avoid adding extra depenencies like Fluxor or BlazorState when the application grows in complexity." Misspelling of "dependencies" Replace "depenencies" with "dependencies"
instructions/tasksync.instructions.md 22 "Use chat for Informations." Incorrect pluralization Replace "Informations" with "information"
instructions/dotnet-upgrade.instructions.md 41 "Post Builds are successfull only after success completion update the CI/CD files" Misspelling of "successful" Replace "successfull" with "successful"
agents/rust-gpt-4.1-beast-mode.agent.md 92 "...continue on to the next step after checkin off a step..." Misspelling of "checking" Replace "checkin" with "checking"
prompts/cosmosdb-datamodeling.prompt.md 44 "...top Entities colections and Documents retention if any for main Entities, total requests/second across all major accelss patterns" Misspellings of "collections" and "access" Replace "colections" with "collections" and "accelss" with "access"
prompts/cosmosdb-datamodeling.prompt.md 618 "...would require siginificant Cosmos DB partition/size..." Misspelling of "significant" Replace "siginificant" with "significant"
prompts/update-avm-modules-in-bicep.prompt.md 8 "...final outout table and summary." Misspelling of "output" Replace "outout" with "output"
skills/refactor/SKILL.md 299 "# EVEN BETER: Using Result type" Misspelling of "better" Replace "BETER" with "BETTER"
prompts/add-educational-comments.prompt.md 64 "...Interpret obvious typos (e.g., Line Numer) using context." Misspelling in example input Replace "Line Numer" with "Line Number" (appears at lines 64, 118, 121)

I can send a PR to fix these -- except for the last one, in which Line Numer should not be corrected because it is an example of an intentional misspelling.

Longer-term, should there be a regular or automatic process to check all files for spelling and grammar?</issue_description>

<agent_instructions>These errors were mostly addressed in #639 but can you now add an action using https://github.com/codespell-project/actions-codespell that will run on CI to fix spelling errors</agent_instructions>

Comments on the Issue (you are @copilot in this section)

@aaronpowell Yes, do send through a PR to correct them, and it'd be good if you could include a GitHub Actions workflow that could be part of the CI process to catch this stuff (I won't pretend I could catch it as I'm appalling at spelling myself 🤣).

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI and others added 2 commits February 2, 2026 23:10
Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com>
Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix spelling and grammar issues detected by codespell Add codespell CI workflow for automated spelling checks Feb 2, 2026
Copilot AI requested a review from aaronpowell February 2, 2026 23:13
Copy link
Copy Markdown
Contributor

@aaronpowell aaronpowell left a comment

Choose a reason for hiding this comment

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

@copilot can you fix the spelling error identified in the CI job

Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com>
Copy link
Copy Markdown
Contributor Author

Copilot AI commented Feb 3, 2026

@copilot can you fix the spelling error identified in the CI job

Fixed the spelling error in .github/copilot-instructions.md (formated → formatted). Commit: 20818f2

Copilot AI requested a review from aaronpowell February 3, 2026 00:23
@aaronpowell aaronpowell marked this pull request as ready for review February 3, 2026 00:45
Copilot AI review requested due to automatic review settings February 3, 2026 00:45
@aaronpowell aaronpowell merged commit b492cfe into main Feb 3, 2026
8 checks passed
@aaronpowell aaronpowell deleted the copilot/fix-spelling-grammar-issues branch February 3, 2026 00:45
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This pull request implements automated spelling checks in the CI pipeline using codespell to prevent typos from being merged into the codebase.

Changes:

  • Adds a new GitHub Actions workflow that runs codespell on all pushes to main and pull requests
  • Configures codespell with appropriate ignore lists for technical terms and intentional example typos
  • Fixes a spelling error in the copilot instructions file (formated → formatted)

Reviewed changes

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

File Description
.github/workflows/codespell.yml Adds CI workflow that runs codespell to check for spelling errors in code and filenames
.codespellrc Configures codespell with ignore lists for technical terms (AKS, EDN, etc.), template literals, and intentional example typos
.github/copilot-instructions.md Corrects spelling error: "formated" → "formatted"

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.

Spelling and grammar auto-check

3 participants