chore(ci): rename lint job to format-check and clarify comments.

Author: Nde-Code

.github/workflows/ci.yaml

@@ -1,12 +1,12 @@
 name: CI
 
 on:
-  # Run workflow when changes are pushed to main branches:
+  # Run workflow when changes are pushed to main branch:
   push:
     branches:
       - main
 
-  # Run workflow for pull requests targeting main branches:
+  # Run workflow for pull requests targeting main branch:
   pull_request:
     branches:
       - main
@@ -19,9 +19,9 @@ permissions:
   contents: read
 
 jobs:
-  # 1st job: lint
-  # This job verifies code formatting and code quality:
-  lint:
+  # 1st job: format-check
+  # This job verifies that the project files follow the configured Prettier formatting rules:
+  format-check:
     # Use ubuntu-latest runner for a consistent Linux environment:
     runs-on: ubuntu-latest
 
@@ -42,13 +42,13 @@ jobs:
       - name: Install dependencies
         run: npm ci
 
-      # Step 4: Verify Prettier formatting:
-      # Fails if files are not correctly formatted.
+      # Step 4: Check Prettier formatting:
+      # Fails if files do not match the project's formatting rules.
       - name: Check Prettier formatting
         run: npm run prettier-check
 
   # 2nd job: type-check
-  # This job verifies Astro and TypeScript correctness:
+  # This job verifies Astro files and TypeScript correctness:
   type-check:
     # Use ubuntu-latest runner:
     runs-on: ubuntu-latest
@@ -58,24 +58,24 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v7
 
-      # Step 2: Setup Node.js:
+      # Step 2: Setup Node.js environment:
       - name: Setup Node.js
         uses: actions/setup-node@v7
         with:
           node-version: 22
           cache: 'npm'
 
-      # Step 3: Install dependencies:
+      # Step 3: Install project dependencies:
       - name: Install dependencies
         run: npm ci
 
       # Step 4: Run Astro diagnostics:
-      # Checks Astro files, TypeScript errors and component issues.
+      # Detects TypeScript errors, invalid Astro components and project issues.
       - name: Run Astro type check
         run: npm run astro-check
 
   # 3rd job: build
-  # This job verifies that the production website can be generated:
+  # This job verifies that the website can be successfully generated for production:
   build:
     # Use ubuntu-latest runner:
     runs-on: ubuntu-latest
@@ -85,18 +85,18 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v7
 
-      # Step 2: Setup Node.js:
+      # Step 2: Setup Node.js environment:
       - name: Setup Node.js
         uses: actions/setup-node@v7
         with:
           node-version: 22
           cache: 'npm'
 
-      # Step 3: Install dependencies:
+      # Step 3: Install project dependencies:
       - name: Install dependencies
         run: npm ci
 
-      # Step 4: Generate production website:
-      # Ensures Astro can successfully compile the project.
+      # Step 4: Build production website:
+      # Ensures Astro can compile the project and generate the final output.
       - name: Build Astro website
         run: npm run build