From 05211441d2a0cb3a3fd97adaedf1bea18757eb90 Mon Sep 17 00:00:00 2001 From: Yaroslav Halchenko Date: Thu, 26 Jun 2025 00:28:05 -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 4aa0270a723ab09f3ad86a4d1d55c50367aeef4d Mon Sep 17 00:00:00 2001 From: Yaroslav Halchenko Date: Thu, 26 Jun 2025 00:28:05 -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..c579725 --- /dev/null +++ b/.codespellrc @@ -0,0 +1,6 @@ +[codespell] +# Ref: https://github.com/codespell-project/codespell#using-a-config-file +skip = .git*,*.lock,.codespellrc +check-hidden = true +# ignore-regex = +# ignore-words-list = From 258ac3c686899858a73b05ebcef2fad87df0acab Mon Sep 17 00:00:00 2001 From: Yaroslav Halchenko Date: Thu, 26 Jun 2025 00:28:06 -0400 Subject: [PATCH 3/3] [DATALAD RUNCMD] chore: run codespell throughout fixing few left 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 412e131..8458f06 100644 --- a/README.md +++ b/README.md @@ -266,7 +266,7 @@ your cards for you. ### SSD Read Speed Requirements -Here's the sequential read speeds you'll need to benchmark specific resoultion & fps combos. If your SSD is not fast +Here's the sequential read speeds you'll need to benchmark specific resolution & fps combos. If your SSD is not fast enough, your maximum fps scores will be lower due to i/o bottlenecking. ```text @@ -315,7 +315,7 @@ you're more than welcome to use other IDE's. It's suggested that you setup automatic formatting in RustRover to avoid the `rustfmt` job failing and blocking your PR. Go to Settings -> Languages and Frameworks -> Rust -> Rustfmt, and -enable `Use Rustfmt instead of the build-in formatter` and `Run Rustfmt automatically on Save`. +enable `Use Rustfmt instead of the built-in formatter` and `Run Rustfmt automatically on Save`. ![rustrover-rustfmt.png](docs%2Frustrover-rustfmt.png)