feat: Add GitHub Actions Workflow to check for typos (#40)

Signed-off-by: Philippe Noël <[email protected]>
Co-authored-by: Philippe Noël <[email protected]>

.codespellignore

@@ -0,0 +1 @@
+socio-economic

.github/workflows/check-typo.yml

@@ -0,0 +1,31 @@
+# workflows/check-typo.yml
+#
+# Check Typo
+# Check Typo using codespell.
+
+name: Check Typo
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened, ready_for_review]
+  workflow_dispatch:
+
+concurrency:
+  group: check-typo-${{ github.head_ref || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  check-typo:
+    name: Check Typo using codespell
+    runs-on: depot-ubuntu-latest-2
+    if: github.event.pull_request.draft == false
+
+    steps:
+      - name: Checkout Git Repository
+        uses: actions/checkout@v4
+
+      - name: Check Typo using codespell
+        uses: codespell-project/actions-codespell@v2
+        with:
+          check_filenames: true
+          ignore_words_file: .codespellignore

CONTRIBUTING.md

@@ -12,7 +12,7 @@ or via [email]([email protected]).
 
 The majority of the development for ParadeDB happens in the [paradedb/paradedb](https://github.com/paradedb/paradedb) monorepo. Pleaser refer to this repository for general development. To develop for this repository, please follow the instructions below.
 
-## Pull Request Worfklow
+## Pull Request Workflow
 
 All changes to ParadeDB happen through GitHub Pull Requests. Here is the recommended
 flow for making a change:

charts/paradedb/docs/Getting Started.md

@@ -23,7 +23,7 @@ helm upgrade --install cnpg \
 
 ## Creating a cluster configuration
 
-Once you have the operator installed, the next step is to prepare the cluster configuration. Whether this will be manged
+Once you have the operator installed, the next step is to prepare the cluster configuration. Whether this will be managed
 via a GitOps solution or directly via Helm is up to you. The following sections outlines the important steps in both cases.
 
 ### Choosing the database type

charts/paradedb/templates/_helpers.tpl

@@ -76,7 +76,7 @@ If a custom imageName is available, use it, otherwise use the defaults based on
 
 {{/*
 Cluster Image
-If imageCatalogRef defined, use it, otherwice calculate ordinary imageName.
+If imageCatalogRef defined, use it, otherwise calculate ordinary imageName.
 */}}
 {{- define "cluster.image" }}
 {{- if .Values.cluster.imageCatalogRef.name }}