Skip to content

Add codespell support with configuration and fixes#123

Open
yarikoptic wants to merge 4 commits into
K-Dense-AI:mainfrom
yarikoptic:enh-codespell
Open

Add codespell support with configuration and fixes#123
yarikoptic wants to merge 4 commits into
K-Dense-AI:mainfrom
yarikoptic:enh-codespell

Conversation

@yarikoptic
Copy link
Copy Markdown

Add codespell configuration and fix existing typos.

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

I personally introduced it to over a hundred of projects already mostly with a positive feedback
(see the "improveit-dashboard").

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

Changes

Configuration & Infrastructure

  • Added .codespellrc with comprehensive skip patterns (ISO/IEC XSD schemas)
  • Created GitHub Actions workflow to check spelling on push to main and PRs
  • Uses codespell-project/actions-codespell@v2 with pinned SHA

Regex Pattern Exclusions

Configured ignore-regex to skip:

  • camelCase/PascalCase identifiers common in code (atLeast, fromT, prSet, etc.)
  • Bold-letter formatting in Markdown (**S**pecific) and LaTeX (\textbf{S}pecific)
  • Regex character classes in code ([Ss]tage)
  • URLs (to avoid "fixing" typos in external links)

Domain-Specific Whitelist

Added ~60 legitimate terms that codespell flags as typos, including:

  • Library/tool names: simpy (SimPy), braket (Amazon Braket), atomate, scarches (scArches), namd
  • Scientific abbreviations: ehr (Electronic Health Records), hsa (Homo sapiens), otu (Operational Taxonomic Unit), cna (Copy Number Alteration), mape (Mean Absolute Percentage Error)
  • Medical terms: infarction, abd (abdomen), anc (Absolute Neutrophil Count), ot (Occupational Therapy)
  • Domain concepts: ket (Dirac notation), blosum (substitution matrix), fallow (Gutenberg diagram), trough (business cycle), stard (reporting standard), lod (Limit of Detection)
  • Code identifiers: ser, fpr, sems, whis, vor, te, ontop, sav

Typo Fixes

  • questonsquestions (imaging-data-commons/SKILL.md)

Testing

✅ Codespell passes with zero errors after all configuration and fixes


🤖 Generated with Claude Code

yarikoptic and others added 4 commits April 6, 2026 12:09
…ists

Added skip for ISO/IEC XSD schemas, ignore-regex for camelCase/PascalCase
identifiers, bold-letter markdown/LaTeX formatting, regex character classes,
and URLs. Added domain-specific terms to ignore-words-list covering scientific
abbreviations, library names, medical terminology, and code identifiers.

Co-Authored-By: Claude Code 2.1.92 / Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Code 2.1.92 / Claude Opus 4.6 <noreply@anthropic.com>
Copy link
Copy Markdown
Contributor

@claude claude Bot left a comment

Choose a reason for hiding this comment

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

Claude Code Review

This pull request is from a fork — automated review is disabled. A repository maintainer can comment @claude review to run a one-time review.

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