From ce4e67d708b09c7b47c7f150b1d29856450a8a87 Mon Sep 17 00:00:00 2001 From: Yaroslav Halchenko Date: Wed, 24 Apr 2024 10:07:23 -0400 Subject: [PATCH 1/3] Add github action to codespell main on push and PRs --- .github/workflows/codespell.yml | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 .github/workflows/codespell.yml diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml new file mode 100644 index 0000000..c59e047 --- /dev/null +++ b/.github/workflows/codespell.yml @@ -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 From bd8c6cfaf01a2712f7b8836d0951de5537f86a8f Mon Sep 17 00:00:00 2001 From: Yaroslav Halchenko Date: Wed, 24 Apr 2024 10:07:23 -0400 Subject: [PATCH 2/3] Add rudimentary codespell config --- .codespellrc | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 .codespellrc diff --git a/.codespellrc b/.codespellrc new file mode 100644 index 0000000..1cd4cac --- /dev/null +++ b/.codespellrc @@ -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 = From 04a2e4d2663ebc0d00c2c0e4f1cb4689f035b97d Mon Sep 17 00:00:00 2001 From: Yaroslav Halchenko Date: Wed, 24 Apr 2024 10:09:58 -0400 Subject: [PATCH 3/3] [DATALAD RUNCMD] run codespell throughout fixing typos automagically === Do not change lines below === { "chain": [], "cmd": "codespell -w", "exit": 0, "extra_inputs": [], "inputs": [], "outputs": [], "pwd": "." } ^^^ Do not change lines above ^^^ --- readme.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/readme.md b/readme.md index f0470b1..b38a8e0 100644 --- a/readme.md +++ b/readme.md @@ -124,7 +124,7 @@ Software to read, write, and manipulate volumetric and/or surface data. - [`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. -- [`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. - [`antsBrainExtraction.sh`](https://dpaniukov.github.io/2016/06/06/brain-extraction-with-ants.html) - [ANTs](http://stnava.github.io/ANTs/) version. @@ -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.