Adds a linter for inclusive language suggestions (#156)

* configure alex, which searches for instances of uninclusive language

* create workflow to scan for non-inclusive language

* do not fail until we've resolved existing warnings

* add comment about scala steward exclusion

* rename workflow

* use npx

Co-authored-by: Akash Askoolum <[email protected]>

* exclude "special"

---------

Co-authored-by: Akash Askoolum <[email protected]>

.alexrc.js

@@ -0,0 +1,5 @@
+exports.profanitySureness = 1;
+exports.allow = [
+    "steward-stewardess", //Exclude this rule as we get false positives from references to Scala Steward
+    "special"
+];

.github/workflows/inclusion.yml

@@ -0,0 +1,29 @@
+# Find full documentation here https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions
+name: Inclusive Language
+
+on:
+  pull_request:
+
+  # Manual invocation.
+  workflow_dispatch:
+
+  push:
+    branches:
+      - main
+
+jobs:
+  inclusion-lint:
+    timeout-minutes: 15
+    runs-on: ubuntu-latest
+
+    # See https://docs.github.com/en/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token
+    permissions:
+      contents: read
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+
+      - name: Run inclusion
+        run: npx alex -q *.md || echo "Catch warnings and exit 0" # Once all warnings have been resolved, remove the second statement