Skip to content

Commit

Permalink
Merge pull request #2 from yarikoptic/enh-codespell
Browse files Browse the repository at this point in the history
Add codespell support (config, workflow to detect/not fix) and make it fix few typos
  • Loading branch information
WillForan authored Apr 24, 2024
2 parents 5d087b4 + 04a2e4d commit 596d9a0
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 2 deletions.
6 changes: 6 additions & 0 deletions .codespellrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[codespell]
# Ref: https://github.com/codespell-project/codespell#using-a-config-file
skip = .git*,.codespellrc
check-hidden = true
# ignore-regex =
# ignore-words-list =
25 changes: 25 additions & 0 deletions .github/workflows/codespell.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Codespell configuration is within .codespellrc
---
name: Codespell

on:
push:
branches: [main]
pull_request:
branches: [main]

permissions:
contents: read

jobs:
codespell:
name: Check for spelling errors
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v4
- name: Annotate locations with typos
uses: codespell-project/codespell-problem-matcher@v1
- name: Codespell
uses: codespell-project/actions-codespell@v2
4 changes: 2 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ Software to read, write, and manipulate volumetric and/or surface data.
<!--lint ignore double-link-->
- [`3dSkullStrip`](https://afni.nimh.nih.gov/pub/dist/doc/program_help/3dSkullStrip.html) - [AFNI](https://afni.nimh.nih.gov/)'s skull stripping utility with many parameters.
<!--lint ignore double-link-->
- [`bet`](https://fsl.fmrib.ox.ac.uk/fsl/fslwiki/BET/UserGuide) - [FSL](https://fsl.fmrib.ox.ac.uk/fsl/fslwiki)'s brain exraction tool.
- [`bet`](https://fsl.fmrib.ox.ac.uk/fsl/fslwiki/BET/UserGuide) - [FSL](https://fsl.fmrib.ox.ac.uk/fsl/fslwiki)'s brain extraction tool.
<!--lint ignore double-link-->
- [`antsBrainExtraction.sh`](https://dpaniukov.github.io/2016/06/06/brain-extraction-with-ants.html) - [ANTs](http://stnava.github.io/ANTs/) version.
<!--lint ignore double-link-->
Expand Down Expand Up @@ -203,7 +203,7 @@ Tools for doing math on matrix values
- [U of A: Neuroimaging Core Documentation](https://neuroimaging-core-docs.readthedocs.io/)

### Boards And Chats
- [neurostars](https://neurostars.org/) - General nueroimaging `dicuss` form. `fmriprep` suggested Q&A site.
- [neurostars](https://neurostars.org/) - General neuroimaging `discuss` form. `fmriprep` suggested Q&A site.
- [afni discuss](https://discuss.afni.nimh.nih.gov) - AFNI's `discuss` instance.
- [brainhack](https://mattermost.brainhack.org/) - A mattermoust community of neuroimagers.

Expand Down

0 comments on commit 596d9a0

Please sign in to comment.