GH Actions: add basic QA workflow

* Lint markdown for consistent code style.
* Lint Yaml files.

Includes documenting what is being checked for via configuration files.
This also ensures that checks can be run locally by contributors.

Author: jrfnl

.github/workflows/basic-qa.yml

@@ -0,0 +1,25 @@
+name: CS
+
+on:
+  # Run on all pushes and on all pull requests.
+  push:
+  pull_request:
+  # Allow manually triggering the workflow.
+  workflow_dispatch:
+
+# Do NOT cancels all previous workflow runs for the same branch that have not yet completed.
+concurrency:
+  # The concurrency group contains the workflow name and the branch name.
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: false
+
+jobs:
+  markdownlint:
+    name: 'Lint Markdown'
+    uses: PHPCSStandards/.github/.github/workflows/reusable-markdownlint.yml@main
+
+  yamllint:
+    name: 'Lint Yaml'
+    uses: PHPCSStandards/.github/.github/workflows/reusable-yamllint.yml@main
+    with:
+      strict: true

.gitignore

@@ -0,0 +1 @@
+node_modules/

.markdownlint-cli2.yaml

@@ -0,0 +1,126 @@
+#
+# Configuration file for MarkdownLint-CLI2.
+#
+# Example file with all options:
+# https://github.com/DavidAnson/markdownlint-cli2/blob/main/test/markdownlint-cli2-yaml-example/.markdownlint-cli2.yaml
+# Example file with all rules:
+# https://github.com/DavidAnson/markdownlint/blob/main/schema/.markdownlint.yaml
+#
+
+# Define glob expressions to use (only valid at root).
+globs:
+  - "**/*.md"
+
+# Show found files on stdout (only valid at root).
+showFound: true
+
+# Define glob expressions to ignore.
+ignores:
+
+# Disable inline config comments.
+noInlineConfig: true
+
+# Disable progress on stdout (only valid at root).
+noProgress: false
+
+# Adjust the configuration for some built-in rules.
+# For full information on the options and defaults, see:
+# https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md
+config:
+  ######################
+  # Disable a few rules.
+  ######################
+  # MD014/commands-show-output : Dollar signs used before commands without showing output.
+  MD014: false
+  # MD028/no-blanks-blockquote : Blank line inside blockquote.
+  MD028: false
+  # MD031/blanks-around-fences - Fenced code blocks should be surrounded by blank lines.
+  MD031: false
+  # MD032/blanks-around-lists - Lists should be surrounded by blank lines.
+  MD032: false
+  # MD041/first-line-heading/first-line-h1 : First line in a file should be a top-level heading.
+  MD041: false
+
+  ##############################
+  # Customize a few other rules.
+  ##############################
+  # MD003/heading-style/header-style - Heading style.
+  MD003:
+    # Heading style - Always use hashes.
+    style: "atx"
+
+  # MD007/ul-indent - Unordered list indentation.
+  MD007:
+    indent: 4
+    # Whether to indent the first level of the list.
+    start_indented: false
+
+  # MD012/no-multiple-blanks - Multiple consecutive blank lines.
+  MD012:
+    maximum: 2
+
+  # MD013/line-length - Line length.
+  MD013:
+    # Number of characters. No need for being too fussy.
+    line_length: 1000
+    # Number of characters for headings.
+    heading_line_length: 100
+    # Number of characters for code blocks.
+    code_block_line_length: 120
+    # Include code blocks.
+    code_blocks: false
+    # Stern length checking (applies to tables, code blocks etc which have their own max line length).
+    stern: true
+
+  # MD022/blanks-around-headings : Headings should be surrounded by blank lines.
+  MD022:
+    # Blank lines above heading.
+    lines_above: [2, 1, 1, 1, 1]
+    # Blank lines below heading.
+    lines_below: [1, 1, 1, -1, -1]
+
+  # MD024/no-duplicate-heading/no-duplicate-header - Multiple headings with the same content.
+  MD024:
+    # Only check sibling headings.
+    siblings_only: true
+
+  # MD026/no-trailing-punctuation : Trailing punctuation in heading.
+  MD026:
+    # Punctuation characters
+    punctuation: ".,;。，；：！"
+
+  # MD033/no-inline-html - Inline HTML.
+  MD033:
+    # Allowed elements.
+    allowed_elements:
+      - div
+      - p
+      - a
+
+  # MD044/proper-names - Proper names should have the correct capitalization.
+  MD044:
+    # List of proper names.
+    names: ["PHP_CodeSniffer", "CodeSniffer", "PHPCSUtils", "PHPCSExtra", "PHPUnit", "Xdebug"]
+    # Include code blocks.
+    code_blocks: false
+
+  # MD046/code-block-style - Code block style.
+  MD046:
+    style: "fenced"
+
+  # MD048/code-fence-style - Code fence style.
+  MD048:
+    style: "backtick"
+
+  # MD049/emphasis-style - Emphasis style should be consistent.
+  MD049:
+    style: "underscore"
+
+  # MD050/strong-style - Strong style should be consistent.
+  MD050:
+    style: "asterisk"
+
+  # MD055/table-pipe-style : Table pipe style.
+  MD055:
+    # Table pipe style.
+    style: "leading_and_trailing"

.yamllint.yml

@@ -0,0 +1,22 @@
+# Details on the default config:
+# https://yamllint.readthedocs.io/en/stable/configuration.html#default-configuration
+extends: default
+
+yaml-files:
+  - '*.yaml'
+  - '*.yml'
+  - '.yamllint'
+
+# Rule documentation: https://yamllint.readthedocs.io/en/stable/rules.html
+rules:
+  colons:
+    max-spaces-after: -1  # Disabled to allow aligning of values.
+  comments:
+    min-spaces-from-content: 1
+  comments-indentation: {}
+  document-start:
+    present: false
+  line-length:
+    max: 145
+  truthy:
+    allowed-values: ["true", "false", "on", "off"]