Skip to content

Commit 0227b8a

Browse files
Copilotaaronpowell
andcommitted
Add codespell GitHub Actions workflow for automatic spelling checks
Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com>
1 parent ea50e5f commit 0227b8a

2 files changed

Lines changed: 38 additions & 0 deletions

File tree

.codespellrc

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
[codespell]
2+
# Ignore intentional misspellings used as examples and technical terms
3+
# numer - intentional example typo in add-educational-comments.prompt.md
4+
# wit - proper technical term/name (sardonic wit, Gilfoyle character trait)
5+
# aks - Azure Kubernetes Service (AKS) abbreviation
6+
# edn - Extensible Data Notation (Clojure data format)
7+
# ser - serialization abbreviation
8+
# ois - ObjectInputStream abbreviation in Java
9+
# gir - valid abbreviation/technical term
10+
# rouge - Rouge is a syntax highlighter (not "rogue")
11+
# categor - appears to be a partial word in code
12+
# aline - proper name (Aline Ávila)
13+
# ative - appears in context of "native" alternatives
14+
ignore-words-list = numer,wit,aks,edn,ser,ois,gir,rouge,categor,aline,ative,afterall,deques
15+
# Skip certain files and directories
16+
skip = .git,node_modules,package-lock.json,*.lock,website/build,website/.docusaurus

.github/workflows/codespell.yml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Check Spelling
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
9+
permissions:
10+
contents: read
11+
12+
jobs:
13+
codespell:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: actions/checkout@v4
17+
18+
- name: Check spelling with codespell
19+
uses: codespell-project/actions-codespell@v2
20+
with:
21+
check_filenames: true
22+
check_hidden: false

0 commit comments

Comments
 (0)