Add spellcheck workflow

Co-authored-by: Christian Kadner <[email protected]>
Signed-off-by: JJ Asghar <[email protected]>
Signed-off-by: BJ Hargrave <[email protected]>

.github/dependabot.yml

@@ -11,6 +11,10 @@ updates:
       interval: "daily"
 
   # Maintain dependencies for Python scripts
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "daily"
   - package-ecosystem: "pip"
     directory: "/tools/maintainers"
     schedule:

.github/workflows/spellcheck.yml

@@ -0,0 +1,45 @@
+# SPDX-License-Identifier: Apache-2.0
+
+name: Spellcheck
+
+on:
+  push:
+    branches:
+      - "main"
+    paths:
+      - '**.md'
+      - '.github/workflows/spellcheck.yml' # This workflow
+  pull_request:
+    branches:
+      - "main"
+    paths:
+      - '**.md'
+      - '.github/workflows/spellcheck.yml' # This workflow
+
+env:
+  LC_ALL: en_US.UTF-8
+
+defaults:
+  run:
+    shell: bash
+
+permissions:
+  contents: read
+
+jobs:
+  spellcheck:
+    name: Spellcheck (en_US)
+    runs-on: ubuntu-latest
+    steps:
+      - name: "Harden Runner"
+        uses: step-security/harden-runner@a4aa98b93cab29d9b1101a6143fb8bce00e2eac4 # v2.7.1
+        with:
+         egress-policy: audit # TODO: change to 'egress-policy: block' after couple of runs
+
+      - name: "Checkout"
+        uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4
+        with:
+          fetch-depth: 0
+
+      - name: Spellcheck
+        uses: rojopolis/spellcheck-github-actions@dbd2f1da869c05ad874fffeb6fe1ed50cd1a6e98 # v0.36.0

.gitignore

@@ -1 +1,6 @@
-venv
+venv/
+.venv/
+.tox/
+dictionary.dic
+.vscode/
+.idea/

.spellcheck-en-custom.txt

@@ -0,0 +1,230 @@
+# make spellcheck-sort
+# Please keep this file sorted:
+# SPDX-License-Identifier: Apache-2.0
+Aakanksha
+aakankshaduggal
+abhi
+Abramson
+Acknowledgements
+Adminstrators
+akashgit
+al
+alimaredia
+Alina
+alinaryan
+Anh
+anik
+Anza
+Approver
+Approvers
+AQuA
+Arapahoe
+ARB
+arge
+Asghar
+Ashgar
+backend
+Bernardino
+bjhargrave
+Boelkins
+Byars
+Bzostek
+caradelia
+CDLA
+cdoern
+CHANGELOG
+Chatbot
+Choi
+ckadner
+CLI
+CNCF
+coc
+CoCC's
+codebase
+codebases
+Conala
+Corbett
+curation
+cybette
+darrellreimer
+dave
+DCO
+De
+deployable
+DeSaix
+dev
+DM
+Doern
+Duggal
+Eder
+Eggebrecht
+et
+Fraknoi
+Freeform
+freeform
+Frontend
+frontend
+Gair
+gcc
+Greenlaw
+GSM
+Haver
+Helpsteer
+HH
+hickeyma
+Hidaka
+Hinrichs
+Huben
+ibm
+ics
+ilab
+Illowsky
+inglis
+InstructLab
+integrations
+Jaideep
+jaideepr
+JamesKunstle
+Janssen
+jeremyeder
+JJ
+jjasghar
+joesepi
+Jolla
+Jonick
+judgement
+juliadenham
+Keene
+kelbrown
+khaledsulayman
+Kordas
+Korol
+Kruse
+Kubernetes
+Kunstle
+LGTM
+LGTMs
+lhawthorn
+lignment
+LLM
+LLM's
+Lovett
+luke
+Lund
+Lyryx
+Mahbobi
+Maintainership
+maintainership
+mairin
+Máirín
+Maredia
+markstur
+Marymount
+Masaki
+McElaney
+md
+Merlinite
+mingxzhao
+Miniforge
+Mixtral
+mmcelaney
+MMLU
+Moebs
+mrutkows
+mscherer
+Multivariable
+Musique
+nathan
+nerdalert
+Neth
+NOIRLab
+noone
+Norwood
+NumGLUE
+OASST
+obuzek
+ODC
+oindrillac
+Oksana
+Oleg
+openbookQA
+Oswego
+ots
+Pfannestiel
+PII
+Prahl
+pre
+Precalculus
+PRM
+pyenv
+PyPI
+pypi
+qa
+Quinnipiac
+Rao
+README
+Rebecca
+Redbooks
+redbooks
+Repo
+repo
+resynthesizes
+RHLF
+Roadmap
+Roush
+russellb
+Saftey
+Sandhills
+Sanny
+Schlicker
+Schneegurt
+Seminario
+Sepi
+SETI
+sexualized
+shivchander
+signoff
+signoffs
+Silkin
+socio
+soltysh
+SPDX
+Spelman
+Spielman
+spzala
+Stanberry
+Standup
+Sudalairaj
+supermajority
+Tatlock
+templated
+Theopold
+Thi
+Tiemann
+TODO
+Triager
+triagers
+Triaging
+UI
+Urone
+USC
+Usings
+Ventura
+venv
+Vickery
+vishnoianil
+Volker
+Vretta
+Wakefield
+Waskiewicz
+weinberg
+Wikimedia
+wikimultihop
+wordmarks
+workstreams
+xukai
+YAML
+yhwang
+Zach
+Zedalis
+Zimmitti

.spellcheck.yml

@@ -0,0 +1,28 @@
+# SPDX-License-Identifier: Apache-2.0
+
+matrix:
+- name: markdown
+  aspell:
+    lang: en
+    d: en_US
+    camel-case: true
+    mode: markdown
+  sources:
+  - "**/*.md|!.tox/**"
+  dictionary:
+    wordlists:
+    - .spellcheck-en-custom.txt
+  pipeline:
+  - pyspelling.filters.context:
+      context_visible_first: true
+      escapes: '\\[\\`~]'
+      delimiters:
+      # Ignore multiline content between fences (fences can have 3 or more back ticks)
+      # ```language
+      # content
+      # ```
+      - open: '(?s)^(?P<open> *`{3,}).*?$'
+        close: '^(?P=open)$'
+      # Ignore text between inline back ticks
+      - open: '(?P<open>`+)'
+        close: '(?P=open)'

CONTRIBUTING.md

@@ -72,7 +72,7 @@ For a list of the maintainers and triagers, see the [MAINTAINERS.md](MAINTAINERS
 
 To propose a new feature, it's best to raise an issue in the appropriate repository:
 
-* [Instructlab CLI repository](https://github.com/instructlab/instructlab/issues)
+* [InstructLab CLI repository](https://github.com/instructlab/instructlab/issues)
 * [Taxonomy repository](https://github.com/instructlab/taxonomy/issues)
 
 This way, features can be discussed with the project maintainers, ensuring that your time is not wasted working on a feature that the project developers will not accept into the codebase.

Collaboration.md

@@ -74,7 +74,7 @@ users | anyone | anyone | members | noone
 
 ## [GitHub Discussions](#github-discussions)
 
-We are using the GitHub discussion boards in each repo for cases where we need to document things quickly but emphemerally, such as working together as a community to squash a nasty bug. In that case, a link to the appropriate discussion board post will be sent to the relevant project mailing lists so folks can follow along on GitHub. Rather than use the discussion boards to discuss proposals for enhancements or to request help with using InstructLab, please reach out on the project [email lists](#email-lists) or [Slack](#chat).
+We are using the GitHub discussion boards in each repo for cases where we need to document things quickly but ephemerally, such as working together as a community to squash a nasty bug. In that case, a link to the appropriate discussion board post will be sent to the relevant project mailing lists so folks can follow along on GitHub. Rather than use the discussion boards to discuss proposals for enhancements or to request help with using InstructLab, please reach out on the project [email lists](#email-lists) or [Slack](#chat).
 
 ## [Hugging Face](#hugging-face)
 

InstructLabSlackGuide.md

@@ -15,7 +15,7 @@ All discussions in the InstructLab Slack are governed by our [project code of co
 
 - `#dev` Cross-project coordination discussion, such as topics that cover both frontend and backend development for InstructLab
 - `#admin` Place to get non-technical help. If you don't know where to go after reading this guide, join this channel for [air traffic control](https://en.wikipedia.org/wiki/Air_traffic_control).
-- `#announce` Project wide announcements such as releases, reminders about community calls, and celebrating new maintainers. This channel is moderated (only [Workspace Adminstrators](https://github.com/instructlab/community/blob/main/InstructLabSlackModerationGuide.md#workspace-administrators) can post) and low-traffic.
+- `#announce` Project wide announcements such as releases, reminders about community calls, and celebrating new maintainers. This channel is moderated (only [Workspace Administrators](https://github.com/instructlab/community/blob/main/InstructLabSlackModerationGuide.md#workspace-administrators) can post) and low-traffic.
 - `#backend` Backend work for the InstructLab project, including pipeline for synthetic data generation, training, model evaluation, and publishing.
 - `#community` Place to discuss community matters such as improving the contributor experience, getting help reviewing a presentation about InstructLab you want to give at a meetup, or learning how you can contribute to InstructLab beyond software development.
 - `#contribhelp` General questions about getting started as an InstructLab contributor. This channel is the place to go if you need help with your first pull request.
@@ -48,5 +48,5 @@ TODO: Update with email address to get help once these are set up.
 
 InstructLab is an open source project and we value defaulting to open in all of our community communications. There are some cases where discussions must happen in private. For the sake of transparency, we are documenting these private channels and what they are used for.
 
-- `#code-of-conduct-committee` Space for the InstructLab [Code of Conduct Committee](https://github.com/instructlab/community/blob/main/COCC.md) to discuss any reports of harassement or other violations of the project Code of Conduct and how to respond to them.
+- `#code-of-conduct-committee` Space for the InstructLab [Code of Conduct Committee](https://github.com/instructlab/community/blob/main/COCC.md) to discuss any reports of harassment or other violations of the project Code of Conduct and how to respond to them.
 - `#mods` Space for the InstructLab [Workspace Administrators](https://github.com/instructlab/community/blob/main/InstructLabSlackModerationGuide.md#workspace-administrators) to confer privately only when necessary. We default to open and hold each other accountable to do so.

InstructLabSlackModerationGuide.md

@@ -15,7 +15,7 @@ Moderation activities can only be performed by users who are designated as works
 
 ## Workspace Administrators
 
-At time of writing, our workspace adminstrators/moderators are as follows:
+At time of writing, our workspace administrators/moderators are as follows:
 
 * Aakanksha Duggal
 * Ali Maredia

Makefile

@@ -20,3 +20,7 @@ endif
 md-lint: ## Lint markdown files
 	$(ECHO_PREFIX) printf "  %-12s ./...\n" "[MD LINT]"
 	$(CMD_PREFIX) podman run --rm -v $(CURDIR):/workdir --security-opt label=disable docker.io/davidanson/markdownlint-cli2:latest > /dev/null
+
+.PHONY: spellcheck-sort
+spellcheck-sort: .spellcheck-en-custom.txt
+	sort -d -f -o $< $<