Merge pull request #6214 from jbampton/add-more-comments

Improve the `pre-commit` and `.github` YAML files

.github/dependabot.yml

@@ -1,12 +1,10 @@
-# Basic set up
+# https://docs.github.com/en/code-security/dependabot/dependabot-version-updates
 version: 2
 updates:
-  # Maintain dependencies for Ruby
   - package-ecosystem: "bundler"
     directory: "/"
     schedule:
       interval: "daily"
-  # Maintain dependencies for GitHub Actions
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:

.github/labeler.yml

@@ -1,3 +1,4 @@
+# https://github.com/actions/labeler
 benchmark:
   - any:
       - changed-files:

.github/linters/.markdown-lint.yml

@@ -1,4 +1,5 @@
 # https://github.com/DavidAnson/markdownlint#rules--aliases
+# https://github.com/igorshubovych/markdownlint-cli
 # markdownlint -c .github/linters/.markdown-lint.yml .
 
 # MD001 heading-increment/header-increment - Heading levels should only increment by one level at a time

.github/workflows/super-linter.yml

@@ -10,7 +10,7 @@ jobs:
   build:
     permissions:
       contents: read # for actions/checkout to fetch code
-      statuses: write # for github/super-linter/slim to mark status of each linter run
+      statuses: write # for super-linter/super-linter/slim to mark status of each linter run
     name: Lint Code Base
     runs-on: ubuntu-latest
     steps:

.pre-commit-config.yaml

@@ -1,4 +1,5 @@
 ---
+# https://pre-commit.com/
 default_stages: [commit, push]
 default_language_version:
   # force all unspecified Python hooks to run python3
@@ -46,7 +47,6 @@ repos:
       - id: codespell
         name: Run codespell
         description: Check spelling with codespell
-        entry: codespell
         args: [--ignore-words=.github/linters/codespell.txt]
   - repo: https://github.com/jumanjihouse/pre-commit-hooks
     rev: 3.0.0