feat(repo): Added readme-format to pre-commit hook

Author: sullivanpj

.github/CONTRIBUTING.md

@@ -2,7 +2,7 @@
 
 # Steps to contribute
 
- If you want to make a small change, go ahead and raise a pull request, otherwise follow these steps:
+If you want to make a small change, go ahead and raise a pull request, otherwise follow these steps:
 
 1. View the [Issues](https://github.com/sullivanpj/open-system/issues) page to see a To-Do list of things to be implemented.
 2. Raise an issue or comment on an existing issue with what you want to contribute if one does not already exist.

.github/PULL_REQUEST_TEMPLATE.md

@@ -6,8 +6,6 @@ Thank you good citizen for your hard work! Please provide the below details desc
 
 **Note:** Please read the [contributing guide](https://github.com/sullivanpj/open-system/blob/main/.github/CONTRIBUTING.md) before raising a pull request.
 
-
-
 ## Pull request type
 
 <!-- Please try to limit your pull request to one type, submit multiple pull requests if needed. -->
@@ -38,4 +36,4 @@ Issue Number: N/A
 
 ## Other information
 
-<!-- Any other information that is important to this PR such as screenshots of how the component looks before and after the change. -->
+<!-- Any other information that is important to this PR such as screenshots of how the component looks before and after the change. -->

.github/codecov.yml

@@ -23,7 +23,7 @@ parsers:
 comment:
   layout: "reach, diff, flags, files"
   behavior: default
-  require_changes: false  # if true: only post the comment if coverage changes
-  require_base: false        # [yes :: must have a base report to post]
-  require_head: true       # [yes :: must have a head report to post]
+  require_changes: false # if true: only post the comment if coverage changes
+  require_base: false # [yes :: must have a base report to post]
+  require_head: true # [yes :: must have a head report to post]
   branches: ["main", "master"]

.github/labels.yml

@@ -75,4 +75,4 @@
   description: "This PR causes a major version bump in the version number."
 - name: "minor"
   color: 0e8a16
-  description: "This PR causes a minor version bump in the version number."
+  description: "This PR causes a minor version bump in the version number."

.github/renovate.json

@@ -5,7 +5,8 @@
     "schedule:weekly",
     ":semanticCommits",
     ":automergePatch",
-    ":noUnscheduledUpdates", ":pinAllExceptPeerDependencies"
+    ":noUnscheduledUpdates",
+    ":pinAllExceptPeerDependencies"
   ],
   "semanticCommits": "enabled",
   "reviewers": ["@sullivanpj"],

.github/stale.yml

@@ -9,7 +9,7 @@ daysUntilClose: 7
 
 # Issues or Pull Requests with these labels will never be considered stale. Set to `[]` to disable
 exemptLabels: []
-  
+
 # Set to true to ignore issues in a project (defaults to false)
 exemptProjects: false
 
@@ -34,7 +34,6 @@ markComment: >
 
 # Limit the number of actions per hour, from 1-30. Default is 30
 limitPerRun: 30
-
 # Limit to only `issues` or `pulls`
 # only: issues
 
@@ -48,4 +47,4 @@ limitPerRun: 30
 
 # issues:
 #   exemptLabels:
-#     - confirmed
+#     - confirmed

.github/workflows/ci.yml

@@ -1,6 +1,5 @@
 name: "CI/CD"
 
-
 on:
   workflow_dispatch:
     inputs:
@@ -9,9 +8,9 @@ on:
         required: false
   push:
     branches:
-      - 'main'
-      - 'alpha'
-      - 'beta'
+      - "main"
+      - "alpha"
+      - "beta"
 
 env:
   NX_DAEMON: false
@@ -22,7 +21,7 @@ env:
 jobs:
   build-and-release:
     if: github.repository == 'sullivanpj/open-system' && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/alpha' || github.ref == 'refs/heads/beta')
-    name: 'Build & Release'
+    name: "Build & Release"
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3

.github/workflows/codeql.yml

@@ -13,12 +13,12 @@ name: "CodeQL"
 
 on:
   push:
-    branches: [ "main" ]
+    branches: ["main"]
   pull_request:
     # The branches below must be a subset of the branches above
-    branches: [ "main" ]
+    branches: ["main"]
   schedule:
-    - cron: '43 13 * * 2'
+    - cron: "43 13 * * 2"
 
 jobs:
   analyze:
@@ -32,45 +32,44 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        language: [ 'javascript' ]
+        language: ["javascript"]
         # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
         # Use only 'java' to analyze code written in Java, Kotlin or both
         # Use only 'javascript' to analyze code written in JavaScript, TypeScript or both
         # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
 
     steps:
-    - name: Checkout repository
-      uses: actions/checkout@v3
+      - name: Checkout repository
+        uses: actions/checkout@v3
 
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
-      with:
-        languages: ${{ matrix.language }}
-        # If you wish to specify custom queries, you can do so here or in a config file.
-        # By default, queries listed here will override any specified in a config file.
-        # Prefix the list here with "+" to use these queries and those in the config file.
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v2
+        with:
+          languages: ${{ matrix.language }}
+          # If you wish to specify custom queries, you can do so here or in a config file.
+          # By default, queries listed here will override any specified in a config file.
+          # Prefix the list here with "+" to use these queries and those in the config file.
 
-        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
-        # queries: security-extended,security-and-quality
+          # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+          # queries: security-extended,security-and-quality
 
+      # Autobuild attempts to build any compiled languages  (C/C++, C#, Go, or Java).
+      # If this step fails, then you should remove it and run the build manually (see below)
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v2
 
-    # Autobuild attempts to build any compiled languages  (C/C++, C#, Go, or Java).
-    # If this step fails, then you should remove it and run the build manually (see below)
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@v2
+      # ℹ️ Command-line programs to run using the OS shell.
+      # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
 
-    # ℹ️ Command-line programs to run using the OS shell.
-    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+      #   If the Autobuild fails above, remove it and uncomment the following three lines.
+      #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
 
-    #   If the Autobuild fails above, remove it and uncomment the following three lines.
-    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+      # - run: |
+      #     echo "Run, Build Application using script"
+      #     ./location_of_script_within_repo/buildscript.sh
 
-    # - run: |
-    #     echo "Run, Build Application using script"
-    #     ./location_of_script_within_repo/buildscript.sh
-
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
-      with:
-        category: "/language:${{matrix.language}}"
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v2
+        with:
+          category: "/language:${{matrix.language}}"

.github/workflows/documentation.yml

@@ -88,5 +88,3 @@ jobs:
 
       - name: Release repository version
         run: pnpm nx run-many --target=semantic-release --parallel=false
-
-

.github/workflows/git-guardian.yml

@@ -16,6 +16,6 @@ jobs:
         env:
           GITHUB_PUSH_BEFORE_SHA: ${{ github.event.before }}
           GITHUB_PUSH_BASE_SHA: ${{ github.event.base }}
-          GITHUB_PULL_BASE_SHA:  ${{ github.event.pull_request.base.sha }}
+          GITHUB_PULL_BASE_SHA: ${{ github.event.pull_request.base.sha }}
           GITHUB_DEFAULT_BRANCH: ${{ github.event.repository.default_branch }}
           GITGUARDIAN_API_KEY: ${{ secrets.GITGUARDIAN_API_KEY }}