Configure codespell pre-commit hook for spell checking (#152)

* Configure `codespell` hook

* exclude `.svg`

* write changes and also exclude `package-lock.json`

* Leave out some wanted words

* One shot pass caught some typos

* A couple of custom corrections

* Try to use builtin dictionary

* Run hook with builtin dictionary

* Delete custom dict

* Add a note in README to run pre-commit hooks locally

Author: arjxn-py

.pre-commit-config.yaml

@@ -0,0 +1,17 @@
+ci:
+  autoupdate_schedule: monthly
+  autofix_prs: true
+
+repos:
+  # Codespell hook configuration
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.3.0
+    hooks:
+      - id: codespell
+        name: Spell Check with Codespell
+        args:
+          - '--write-changes'
+          - '--ignore-words-list=cppp,normale'
+          - '--builtin=en-GB_to_en-US'
+        # Exclude package-lock.json and all .svg files
+        exclude: 'package-lock\.json|\.svg$'

README.md

@@ -39,3 +39,29 @@ $ GIT_USER=<Your GitHub username> yarn deploy
 ```
 
 If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
+
+### Pre-commit Hook Setup
+
+To ensure code quality and consistency, we use `pre-commit` hooks. Here's how to set up and run the pre-commit hook locally:
+
+1. **Install pre-commit:**
+
+   If `pre-commit` isn't already installed, you can install it using `pip`:
+
+   ```bash
+   $ pip install pre-commit
+   ```
+2. **Install the pre-commit hooks:**
+
+   Once `pre-commit` is installed, set up the hooks for the repository by running:
+
+   ```bash
+   $ pre-commit install
+   ```
+3. **Run pre-commit hooks manually:**
+
+   To run the `pre-commit` hooks on all files manually, use:
+
+   ```bash
+   $ pre-commit run --all-files
+   ```

src/components/about/Team/Ian.md

@@ -1,5 +1,5 @@
 Ian Thomas is a Scientific Software Developer at QuantStack. He holds a BA in Physics from Oxford University and PhD in ocean modeling from the University of Southampton.
 
-He has particular interest in data analysis and visualisation, leaning towards solving mathematical and geometric problems.
+He has particular interest in data analysis and visualization, leaning towards solving mathematical and geometric problems.
 
-Ian has many years' experience as an open-source contributor. He is a core maintainer of <a href="https://github.com/bokeh/bokeh">Bokeh</a>, a library for interactive visualisation in web browsers, and the lead maintainer of <a href="https://github.com/contourpy/contourpy">ContourPy</a>, a Python/C++ library for calculating contours. He has also made significant contributions to <a href="https://github.com/matplotlib/matplotlib">Matplotlib</a> and <a href="https://github.com/holoviz/datashader">Datashader</a>.
+Ian has many years' experience as an open-source contributor. He is a core maintainer of <a href="https://github.com/bokeh/bokeh">Bokeh</a>, a library for interactive visualization in web browsers, and the lead maintainer of <a href="https://github.com/contourpy/contourpy">ContourPy</a>, a Python/C++ library for calculating contours. He has also made significant contributions to <a href="https://github.com/matplotlib/matplotlib">Matplotlib</a> and <a href="https://github.com/holoviz/datashader">Datashader</a>.

src/components/about/Team/Joel.md

@@ -1,4 +1,4 @@
-Before joining QuantStack, Joël worked since 2003 in various companies covering a large spectre of domains all dominated by performance constraints: games, embedded software of all sorts, robotics (<a href="https://www.softbankrobotics.com/">Softbank-Robotics/Aldebaran</a>), "heavy" interractive web apps (<a href="https://jellynote.com">https://jellynote.com</a> score player for example)...
+Before joining QuantStack, Joël worked since 2003 in various companies covering a large spectre of domains all dominated by performance constraints: games, embedded software of all sorts, robotics (<a href="https://www.softbankrobotics.com/">Softbank-Robotics/Aldebaran</a>), "heavy" interactive web apps (<a href="https://jellynote.com">https://jellynote.com</a> score player for example)...
 
 Through the years Joël participated to various open-source projects with, in recent years, a particular focus on dependency management for C++ projects (like <a href="https://build2.org">build2</a>) and the <a href="https://webassembly.org/">WebAssembly</a> platform.
 

src/components/about/styles.module.css

@@ -10,7 +10,7 @@
 }
 
 .small_portrait_card:hover {
-  border: solid 1px grey;
+  border: solid 1px gray;
   cursor: pointer; 
   text-decoration: #0000EE underline;
 }

src/components/blog/_config.yml

@@ -538,7 +538,7 @@ blog:
     authors: Mariana Meireles
 
   - url: https://blog.jupyter.org/a-visual-debugger-for-jupyter-914e61716559
-    title: A Visual Debuger for Jupyter
+    title: A Visual Debugger for Jupyter
     image: https://miro.medium.com/max/933/0*9pVDg58cTz5Yezw8.gif
     summary: Most of the progress made in software projects comes from incrementalism. The ability to quickly see the outcome of an execution and iterate has been one of the main reasons for the success of…
     date: Mar 25, 2020

src/components/blog/blogpostsDetails.json

@@ -1028,7 +1028,7 @@
   },
   {
     "url": "https://blog.jupyter.org/a-visual-debugger-for-jupyter-914e61716559",
-    "title": "A Visual Debuger for Jupyter",
+    "title": "A Visual Debugger for Jupyter",
     "image": "/img/blogposts/A-Visual-Debuger-for-Jupyter.gif",
     "summary": "Most of the progress made in software projects comes from incrementalism. The ability to quickly see the outcome of an execution and iterate has been one of the main reasons for the success of…",
     "date": "Mar 25, 2020",

src/components/contact/index.tsx

@@ -17,7 +17,7 @@ export function Contact() {
           <ContactIllustration
             height={"460px"}
             alt={
-              "Illustration for the contact page with a woman, a mobile phone and an enveloppe."
+              "Illustration for the contact page with a woman, a mobile phone and an envelope."
             }
           />
         </div>

src/components/home/Hero/styles.module.css

@@ -36,7 +36,7 @@
   }
 
   .pydata_informations {
-    color: grey;
+    color: gray;
     font-size: 12px;
     font-weight: 600;
     position: absolute;
@@ -70,7 +70,7 @@
   }
 
   .pydata_informations {
-    color: grey;
+    color: gray;
     font-size: var(--ifm-font-size-small);
     font-weight: 600;
     position: absolute;
@@ -132,7 +132,7 @@
   }
 
   .pydata_informations {
-    color: grey;
+    color: gray;
     font-size: var(--ifm-font-size-medium);
     font-weight: 600;
     position: absolute;

src/components/home/WhatWeDo/topics/Computing.md

@@ -1 +1 @@
-We created several popular scientific computing packages. XSimd, an unified API for SIMD opreations, adopted by projects such as Apache Arrox, FireFox, Kytra, Pythran... Xtensor, a C++ n-dimensional array librairy with broadcasting and lazy evaluation.
+We created several popular scientific computing packages. XSimd, an unified API for SIMD operations, adopted by projects such as Apache Arrox, FireFox, Kytra, Pythran... Xtensor, a C++ n-dimensional array library with broadcasting and lazy evaluation.

src/components/projects/descriptions/Header.md

@@ -5,5 +5,5 @@ from data sciences to robotics.
 
 Open-source development is a unique
 way to break down collaboration barriers and reach users with
-unexpected use cases. Enabling customisation and extensions of the
+unexpected use cases. Enabling customization and extensions of the
 tools enables this diversity of applications.

src/css/custom.css

@@ -30,7 +30,7 @@
   --ifm-text-color-footer: black;
 
   /*popup overlay*/
-  --ifm-background-color-popup-overlay: grey;
+  --ifm-background-color-popup-overlay: gray;
 
   /* Font sizes */
   --ifm-font-size-small: 14px;