Merge pull request #645 from github/copilot/fix-spelling-grammar-issues

Add codespell CI workflow for automated spelling checks
This commit is contained in:
Aaron Powell
2026-02-03 11:45:56 +11:00
committed by GitHub
3 changed files with 39 additions and 1 deletions

16
.codespellrc Normal file
View File

@@ -0,0 +1,16 @@
[codespell]
# Ignore intentional misspellings used as examples and technical terms
# numer - intentional example typo in add-educational-comments.prompt.md
# wit - proper technical term/name (sardonic wit, Gilfoyle character trait)
# aks - Azure Kubernetes Service (AKS) abbreviation
# edn - Extensible Data Notation (Clojure data format)
# ser - serialization abbreviation
# ois - ObjectInputStream abbreviation in Java
# gir - valid abbreviation/technical term
# rouge - Rouge is a syntax highlighter (not "rogue")
# categor - TypeScript template literal in website/src/scripts/pages/skills.ts:70 (categor${...length > 1 ? "ies" : "y"})
# aline - proper name (Aline Ávila, contributor)
# ative - part of "Declarative Agents" in TypeSpec M365 Copilot documentation (collections/typespec-m365-copilot.collection.md)
ignore-words-list = numer,wit,aks,edn,ser,ois,gir,rouge,categor,aline,ative,afterall,deques
# Skip certain files and directories
skip = .git,node_modules,package-lock.json,*.lock,website/build,website/.docusaurus

View File

@@ -25,7 +25,7 @@ The following instructions are only to be applied when performing a code review.
- [ ] The instruction has a `description` field.
- [ ] The `description` field is not empty.
- [ ] The file name is lower case, with words separated by hyphens.
- [ ] The instruction has an `applyTo` field that specifies the file or files to which the instructions apply. If they wish to specify multiple file paths they should formated like `'**.js, **.ts'`.
- [ ] The instruction has an `applyTo` field that specifies the file or files to which the instructions apply. If they wish to specify multiple file paths they should formatted like `'**.js, **.ts'`.
## Agent file guide

22
.github/workflows/codespell.yml vendored Normal file
View File

@@ -0,0 +1,22 @@
name: Check Spelling
on:
push:
branches: [main]
pull_request:
branches: [main]
permissions:
contents: read
jobs:
codespell:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Check spelling with codespell
uses: codespell-project/actions-codespell@v2
with:
check_filenames: true
check_hidden: false