From f95ca7aca7240e239a0b6e50be24a3a585cead1d Mon Sep 17 00:00:00 2001 From: Yaroslav Halchenko Date: Mon, 28 Aug 2023 18:55:39 -0400 Subject: [PATCH 1/5] Add github action to codespell devel on push and PRs Signed-off-by: Yaroslav Halchenko --- .github/workflows/codespell.yml | 20 ++++++++++++++++++++ 1 file changed, 20 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..97e4fe5 --- /dev/null +++ b/.github/workflows/codespell.yml @@ -0,0 +1,20 @@ +--- +name: Codespell + +on: + push: + pull_request: + +permissions: + contents: read + +jobs: + codespell: + name: Check for spelling errors + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v3 + - name: Codespell + uses: codespell-project/actions-codespell@v2 From 6e65a73ab91e58119b87e085af0c7dfd6041197c Mon Sep 17 00:00:00 2001 From: Yaroslav Halchenko Date: Mon, 28 Aug 2023 18:55:39 -0400 Subject: [PATCH 2/5] Add rudimentary codespell config Signed-off-by: Yaroslav Halchenko --- .codespellrc | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 .codespellrc diff --git a/.codespellrc b/.codespellrc new file mode 100644 index 0000000..da3c057 --- /dev/null +++ b/.codespellrc @@ -0,0 +1,4 @@ +[codespell] +skip = .git,*.pdf,*.svg +# +# ignore-words-list = From 247774822c2ad2dedcb68c87a561a68f6237fa38 Mon Sep 17 00:00:00 2001 From: Yaroslav Halchenko Date: Mon, 28 Aug 2023 18:55:39 -0400 Subject: [PATCH 3/5] Add pre-commit definition for codespell Signed-off-by: Yaroslav Halchenko --- .pre-commit-config.yaml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 6787a11..5732e35 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -30,3 +30,7 @@ repos: "-sn", # Don't display the score "--rcfile=.pylintrc", # Link to your config file ] + - repo: https://github.com/codespell-project/codespell + rev: v2.2.5 + hooks: + - id: codespell From d2fa80196f636c79c0ecf46a83ac15b27eaa99bb Mon Sep 17 00:00:00 2001 From: Yaroslav Halchenko Date: Mon, 28 Aug 2023 18:56:08 -0400 Subject: [PATCH 4/5] ignore poped (not sure why not to make it popped) Signed-off-by: Yaroslav Halchenko --- .codespellrc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.codespellrc b/.codespellrc index da3c057..54b143e 100644 --- a/.codespellrc +++ b/.codespellrc @@ -1,4 +1,4 @@ [codespell] skip = .git,*.pdf,*.svg -# -# ignore-words-list = +# poped - loved variable name +ignore-words-list = poped From cf90ab2858bfe1e3b285c6b757f923b192ee75c6 Mon Sep 17 00:00:00 2001 From: Yaroslav Halchenko Date: Fri, 8 Mar 2024 18:37:18 -0500 Subject: [PATCH 5/5] Run codespell throughout fixing typos automagically Signed-off-by: Yaroslav Halchenko --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c4ca8e6..a238a37 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -35,7 +35,7 @@ $ pip install '.[devel]' $ pre-commit install ``` 4. Create a new branch, develop and add tests when possible -5. Run linting & testing before commiting code. Ensure all the hooks are passing. +5. Run linting & testing before committing code. Ensure all the hooks are passing. ```shell $ pre-commit run --all-files ```