chore

Author: denisecase

.github/dependabot.yml

@@ -1,13 +1,26 @@
-# WHY: Automatically updates GitHub Actions to latest versions
-# OBS: Runs monthly to keep actions secure and up-to-date
-# REQ: Keep this file to maintain security patches in workflows
+# ============================================================
+# .github/dependabot.yml (Check for GitHub Actions updates)
+# ============================================================
+# SOURCE: https://github.com/denisecase/templates
+#
+# REQ.PROJECT: This repository SHOULD track GitHub Actions updates automatically.
+# WHY-FILE: GitHub Actions are executable dependencies and may receive security or behavior updates.
+# OBS: Language-level dependencies (e.g., Python packages) are upgraded manually.
+# OBS: GitHub Actions are the only dependency class automated here.
+# ALT: Dependabot could be omitted if workflows are pinned and reviewed manually.
+# CUSTOM: Update interval if CI cadence or security posture changes.
 
-version: 2
+# NOTE: This file automatically updates the versions used in Actions workflows.
+# You don't need to modify this file.
+# To disable: Delete this file or set enabled: false below.
+# enabled: false # Uncomment to disable Dependabot
+
+version: 2 # Dependabot configuration version
 
 updates:
-  - package-ecosystem: "github-actions" # WHY: Updates action versions in workflows
-    directory: "/" # WHY: Scan all .github/workflows/*.yml files
+  - package-ecosystem: "github-actions" # Dependency type
+    directory: "/" # Location of GitHub Actions workflows
     schedule:
-      interval: "monthly" # WHY: Monthly updates balance freshness vs notification noise
+      interval: "monthly" # ALT: Use "weekly" for higher security when needed
     commit-message:
-      prefix: "ci(deps)" # WHY: Conventional commit format for changelog tools
+      prefix: "(deps)"  # WHY: enable filtering by commit type

.github/workflows/links.yml

@@ -27,8 +27,8 @@ jobs:
       pull-requests: write
 
     steps:
-      - name: A1) Checkout repository code
-        uses: actions/checkout@v6 # OBS: v6 current as of Dec 2025
+      - name: 1) Checkout repository code
+        uses: actions/checkout@v6
 
       - name: 2) Check links with Lychee
         uses: lycheeverse/lychee-action@v2

.pre-commit-config.yaml

@@ -1,3 +1,7 @@
+# ============================================================
+# .yamllint.yml (YAML linting configuration)
+# ============================================================
+
 # WHY: Enforce YAML correctness without arbitrary style constraints.
 # OBS: Default yamllint rules conflict with GitHub Actions YAML.
 #      Line length, document start, truthy, and comment spacing are intentionally disabled.

.yamllint.yml

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 Denise M. Case
+Copyright (c) 2025-2026 Denise M. Case
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

LICENSE

@@ -1,14 +1,15 @@
+# ============================================================
+# lychee.toml (Lychee link checker configuration)
+# ============================================================
+
+# REQ.PROJECT: Automatic link checking using GitHub Actions and Lychee.
 # WHY-FILE: Shared Lychee configuration (lychee.toml) for documentation-heavy repositories.
-# REQ.PROJECT: Link checking MUST be non-flaky and CI-safe.
+# REQ: Link checking MUST be reliable and CI-safe.
 # WHY: Configures Lychee link checker behavior for CI/CD.
 # OBS: Flat structure required by lychee v0.22+; no nested sections.
 # OBS: No path exclusions; all documentation files are expected to be link-clean.
-# OBS: Link integrity supports Structural Explainability (SE)
-#      by preserving stable, reconstructible references over time.
-# OBS: Link integrity also benefits Contextual Evidence & Explanations (CEE)
-#      by maintaining the availability of cited evidence and provenance,
-#      without enforcing interpretation.
-
+# OBS: Link integrity preserves stable, reconstructible references over time.
+# OBS: Link integrity maintains connections to external resources.
 
 # WHY: Control verbosity and CI-friendly output
 verbose = "info"   # WHY: Balance between detail and noise