Merge pull request #2 from shaavan/add-ci-workflows

Add CI workflows for markdown linting and spell checking

.github/workflows/markdown-lint.yml

@@ -0,0 +1,26 @@
+name: Markdown Lint
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  markdown-lint:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    - name: Set up Node.js environment
+      uses: actions/setup-node@v2
+      with:
+        node-version: '16'  # Upgrade to Node.js version 16
+
+    - name: Install markdownlint-cli
+      run: npm install -g markdownlint-cli
+
+    - name: Run markdownlint on markdown files
+      run: markdownlint '**/*.md'

.github/workflows/spell-check.yml

@@ -0,0 +1,24 @@
+name: Spell Check
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  spell-check:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    - name: Install aspell
+      run: sudo apt-get install -y aspell aspell-en
+
+    - name: Install pyspelling
+      run: pip install pyspelling
+
+    - name: Run Spell Checker
+      run: pyspelling -c spellcheck.yaml

README.md

@@ -1,29 +1,40 @@
 # Code Chronicle
 
-Welcome to **Code Chronicle** — a daily log of my open-source development journey. This repository is a space where I track my daily coding activities, progress, challenges, and reflections. It serves as a structured journal to maintain accountability, learn from each day, and document my path as an open-source developer.
+Welcome to **Code Chronicle** — a daily log of my open-source development
+journey. This repository is a space where I track my daily coding activities,
+progress, challenges, and reflections. It serves as a structured journal to
+maintain accountability, learn from each day, and document my path as an
+open-source developer.
 
 ## Purpose
 
 This repository exists to:
-- Keep a clear and organized record of daily work and accomplishments.
-- Document challenges and solutions encountered along the way.
-- Reflect on progress and maintain a habit of continuous learning.
-- Provide a transparent view of my development process for personal growth and collaboration.
+
+- Keep a clear and organized record of daily work and accomplishments.  -
+Document challenges and solutions encountered along the way.  - Reflect on
+progress and maintain a habit of continuous learning.  - Provide a transparent
+view of my development process for personal growth and collaboration.
 
 ## Structure
 
-- The repository is divided into two types of logs: **Daily** & **Monthly**.
-- **Daily Logs** contain a brief description of achievements and challenges faced on that day.
-- **Monthly Summaries** provide a detailed overview of the problems solved, lessons learned, and development progress over the course of the month.
+- The repository is divided into two types of logs: **Daily** & **Monthly**.  -
+**Daily Logs** contain a brief description of achievements and challenges faced
+on that day.  - **Monthly Summaries** provide a detailed overview of the
+problems solved, lessons learned, and development progress over the course of
+the month.
 
 ## Inspiration
 
-Code Chronicle is inspired by the idea of combining structured progress tracking with personal reflection. As an open-source developer, this journal helps me stay accountable while allowing me to look back and learn from my journey.
+diff
+Code Chronicle is inspired by the idea of combining structured progress tracking
+with personal reflection. As an open-source developer, this journal helps me
+stay accountable while allowing me to look back and learn from my journey.
 
 ---
 
-Feel free to check back regularly for updates on my work and the insights gained from this development process!
+Feel free to check back regularly for updates on my work and the insights gained
+from this development process!
 
 ## License
 
-This project is open-source and available under the [MIT License](LICENSE).
+This project is open-source and available under the [MIT License](LICENSE).

spellcheck.yaml

@@ -0,0 +1,16 @@
+# spellcheck.yaml
+
+matrix:
+  - name: Markdown Files
+    sources:
+      - '**/*.md'  # Check all markdown files in the repository
+    dictionary:
+      # Use the default language dictionary (no need for a list of dictionaries)
+      language: en_US  # Specify the language
+    # List of custom words to exclude (e.g., technical terms, proper names)
+    ignore_words:
+      - GitHub
+      - markdownlint
+      - pyspelling
+      - CI
+      - lint