From f99d3e5241704e6fa94ee3ef98629d82715301f5 Mon Sep 17 00:00:00 2001
From: jrfnl <jrfnl@users.noreply.github.com>
Date: Tue, 17 Jun 2025 00:07:06 +0200
Subject: [PATCH 1/5] ALT spelling option

---
 .github/workflows/basic-qa.yml | 13 +++++++++++++
 _typos.toml                    | 15 +++++++++++++++
 2 files changed, 28 insertions(+)
 create mode 100644 _typos.toml

diff --git a/.github/workflows/basic-qa.yml b/.github/workflows/basic-qa.yml
index 1fafbe8..29974eb 100644
--- a/.github/workflows/basic-qa.yml
+++ b/.github/workflows/basic-qa.yml
@@ -77,3 +77,16 @@ jobs:
         # yamllint disable-line rule:line-length
         if: ${{ steps.spellcheck.outputs.success == false && steps.spellcheck.outputs.number_of_issues != 11  && steps.spellcheck.outputs.number_of_files_with_issues != 5}}
         run: exit 1
+
+  spellcheck-5:
+    name: Spellcheck-5
+    # Config file: _typos.toml
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: "Search for misspellings"
+        uses: "crate-ci/typos@v1"
diff --git a/_typos.toml b/_typos.toml
new file mode 100644
index 0000000..b94013d
--- /dev/null
+++ b/_typos.toml
@@ -0,0 +1,15 @@
+[files]
+extend-exclude = [
+    ".git/",
+]
+ignore-hidden = true
+
+[default]
+locale = "en-gb"
+check-filename = true
+
+[default.extend-words]
+# Don't correct for the CLI flag name.
+colors = "colors"
+# Don't correct for the Zend tooling name.
+Analyzer = "Analyzer"

From 3cec4297d11959a69c854f0aaa1f87fe452ef91b Mon Sep 17 00:00:00 2001
From: jrfnl <jrfnl@users.noreply.github.com>
Date: Sun, 15 Jun 2025 13:49:48 +0200
Subject: [PATCH 2/5] GH Actions: add Remark lint

---
 .github/workflows/basic-qa.yml |  4 ++++
 .remarkignore                  |  5 +++++
 .remarkrc                      | 36 ++++++++++++++++++++++++++++++++++
 3 files changed, 45 insertions(+)
 create mode 100644 .remarkignore
 create mode 100644 .remarkrc

diff --git a/.github/workflows/basic-qa.yml b/.github/workflows/basic-qa.yml
index 29974eb..b840ff0 100644
--- a/.github/workflows/basic-qa.yml
+++ b/.github/workflows/basic-qa.yml
@@ -18,6 +18,10 @@ jobs:
     name: 'Lint Markdown'
     uses: PHPCSStandards/.github/.github/workflows/reusable-markdownlint.yml@main
 
+  remark:
+    name: 'QA Markdown'
+    uses: PHPCSStandards/.github/.github/workflows/reusable-remark.yml@main
+
   yamllint:
     name: 'Lint Yaml'
     uses: PHPCSStandards/.github/.github/workflows/reusable-yamllint.yml@main
diff --git a/.remarkignore b/.remarkignore
new file mode 100644
index 0000000..0ee28ea
--- /dev/null
+++ b/.remarkignore
@@ -0,0 +1,5 @@
+# Ignore rules for Remark.
+# Docs: https://github.com/unifiedjs/unified-engine/blob/HEAD/doc/ignore.md
+
+/build/
+/node_modules/
diff --git a/.remarkrc b/.remarkrc
new file mode 100644
index 0000000..95c4c32
--- /dev/null
+++ b/.remarkrc
@@ -0,0 +1,36 @@
+{
+  "plugins": [
+    "remark-gfm",
+    ["remark-lint-checkbox-character-style", "consistent"],
+    ["remark-lint-checkbox-content-indent", "consistent"],
+    "remark-lint-definition-spacing",
+    "remark-lint-file-extension",
+    ["remark-lint-linebreak-style", "unix"],
+    ["remark-lint-link-title-style", "\""],
+    ["remark-lint-ordered-list-marker-style", "."],
+    "remark-lint-no-dead-urls",
+    "remark-lint-no-duplicate-defined-urls",
+    "remark-lint-no-duplicate-definitions",
+    "remark-lint-no-empty-url",
+    "remark-lint-no-file-name-consecutive-dashes",
+    "remark-lint-no-file-name-irregular-characters",
+    "remark-lint-no-file-name-outer-dashes",
+    "remark-lint-no-heading-like-paragraph",
+    "remark-lint-no-literal-urls",
+    "remark-lint-no-reference-like-url",
+    "remark-lint-no-shortcut-reference-image",
+    "remark-lint-no-table-indentation",
+    "remark-lint-no-undefined-references",
+    "remark-lint-no-unneeded-full-reference-image",
+    "remark-lint-no-unneeded-full-reference-link",
+    "remark-lint-no-unused-definitions",
+    ["remark-lint-strikethrough-marker", "~~"],
+    ["remark-lint-table-cell-padding", "consistent"],
+    "remark-lint-heading-whitespace",
+    "remark-lint-list-item-punctuation",
+    "remark-lint-match-punctuation",
+    "remark-lint-no-hr-after-heading",
+    "remark-lint-are-links-valid-duplicate",
+    "remark-validate-links"
+  ]
+}

From a4211ec466d5468ff511ad630dcc8dcdf01c57f5 Mon Sep 17 00:00:00 2001
From: jrfnl <jrfnl@users.noreply.github.com>
Date: Sun, 15 Jun 2025 11:38:33 +0200
Subject: [PATCH 3/5] WIP | Add CONTRIBUTING

---
 CONTRIBUTING.md | 40 ++++++++++++++++++++++++++++++++++++++++
 README.md       |  5 +++++
 2 files changed, 45 insertions(+)
 create mode 100644 CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..632aa5d
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,40 @@
+# Contributing to the PHP_CodeSniffer documentation
+
+## PHP_CodeSniffer Wiki
+
+For now, the documentation for the PHP_CodeSniffer project is available via the [project Wiki](https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki).
+
+### Contributing to the Wiki
+
+If you would like to improve the documentation:
+1. Fork this repo.
+2. Create a new branch off the `main` branch.
+3. Make your changes. The Wiki source files are in the `/wiki` subdirectory.
+4. Commit your changes with a meaningful commit message.
+5. Push your changes to your fork.
+6. Submit a pull request from your fork to this repository.
+
+When in doubt, open an issue first to discuss your change proposal.
+
+### How does the wiki get updated ?
+
+* The source of the Wiki was imported into this repository to maintain the commit history.
+* A [GitHub Actions workflow](https://github.com/PHPCSStandards/PHP_CodeSniffer-documentation/blob/main/.github/workflows/publish-wiki.yml) was added to automatically push changes made in the Wiki files to the upstream Wiki repo.
+* Prior to pushing the changes, the workflow will make various changes to the files:
+    * Replace `<!-- START doctoc --> <!-- END doctoc -->` placeholders with a Table of Contents for the page in Markdown.
+    * Replace `{{ .... }}` CLI output placeholders with actual CLI output.
+        The code samples used for this can be found in the `build/wiki/code-samples` directory.
+
+### Guidelines
+
+* Always use fully qualified links. This ensures that the links will work when pages are viewed/edited in this repo, as well as when the pages are viewed from the PHPCS wiki.
+
+
+### Frequently Asked Questions
+
+#### Why not make the Wiki publicly editable ?
+
+Publicly editable Wiki pages for big projects get vandalized pretty often and we don't want to risk this type of vandalism leading to users getting incorrect information.
+
+As a secondary reason, there are parts of the wiki (especially the output examples) which were pretty out of date.
+By having the wiki source in this repo, it allows for automating certain updates which would otherwise have to be done manually.
diff --git a/README.md b/README.md
index 174bbda..38f9f65 100644
--- a/README.md
+++ b/README.md
@@ -8,3 +8,8 @@ The intention is for that website to be a GitHub Pages/Jekyll site, but we'll ne
 In the mean time, the documentation for the PHP_CodeSniffer project is available via the [project Wiki](https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki) and made publicly editable via this repository.
 
 _This is an interim solution and the intention is to eventually migrate the wiki documentation to the website._
+
+
+## Want to contribute ?
+
+Have a look at the [CONTRIBUTING guide](CONTRIBUTING.md).

From de2e39a92f808cfc3e8102d01ab4a9985bdcf74a Mon Sep 17 00:00:00 2001
From: jrfnl <jrfnl@users.noreply.github.com>
Date: Sun, 15 Jun 2025 11:41:22 +0200
Subject: [PATCH 4/5] WIP | Add issue and PR templates

---
 .github/ISSUE_TEMPLATE/bug_report.md      | 78 +++++++++++++++++++++++
 .github/ISSUE_TEMPLATE/feature_request.md | 22 +++++++
 .github/pull_request_template.md          | 32 ++++++++++
 3 files changed, 132 insertions(+)
 create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md
 create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md
 create mode 100644 .github/pull_request_template.md

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 0000000..da94022
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,78 @@
+---
+name: "\U0001F41B Bug report for sniffs"
+about: I got unexpected behavior and think it is a bug.
+title: ''
+
+---
+
+<!--
+PLEASE FILL OUT THE TEMPLATE COMPLETELY.
+BUG REPORTS WHICH CANNOT BE REPRODUCED BASED ON THE INFORMATION PROVIDED WILL BE CLOSED.
+-->
+
+## Bug Description
+<!-- Provide a clear and concise description of the problem you are experiencing. -->
+
+
+## Given the following reproduction Scenario
+<!-- Please provide example code that allows us to reproduce the issue. Do NOT paste screenshots of code! -->
+
+The issue happens when running this command:
+<!-- Adjust the below command as appropriate. -->
+```bash
+phpcs -ps file.php --standard=...
+```
+
+... over a file containing this code:
+```php
+// Place your code sample here.
+```
+
+<!-- Optionally post a *minimal* version of your custom ruleset here if needed to reproduce the issue. -->
+... with this custom ruleset:
+```xml
+<?xml version="1.0"?>
+<ruleset name="My Custom Standard">
+  ...
+</ruleset>
+```
+
+
+### I'd expect the following behaviour
+<!-- What was the expected (correct) behavior? -->
+
+
+### Instead this happened
+<!--
+What is the current (buggy) behavior?
+Please provide as much information as possible and relevant.
+
+Whenever possible, include the error message and the error code for the sniff that is being
+(or should have been) triggered.
+You can see the sniff error codes by running `phpcs` with the `-s` flag.
+Example: `Universal.Arrays.DuplicateArrayKey.Found`
+-->
+
+
+## Environment
+<!--
+Please include as many details as relevant about the environment you experienced the bug in.
+You should be able to get the version numbers using the `composer info` command.
+-->
+
+| Environment             | Answer                                                                         |
+| ----------------------- | ------------------------------------------------------------------------------ |
+| PHP version             | x.y.z                                                                          |
+| PHP_CodeSniffer version | x.y.z                                                                          |
+| PHPCSExtra version      | x.y.z                                                                          |
+| PHPCSUtils version      | x.y.z                                                                          |
+| Install type            | e.g. Composer global, Composer project local, git clone, other (please expand) |
+
+
+## Additional Context (optional)
+<!-- Add any other context about the problem here. -->
+
+
+## Tested Against `develop` branch?
+
+- [ ] I have verified the issue still exists in the `develop` branch of PHPCSExtra.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 0000000..c6a0522
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,22 @@
+---
+name: "\U0001F680 Feature request"
+about: I have a suggestion (and may want to implement it).
+title: ''
+
+---
+
+## Is your feature request related to a problem?
+<!-- Please provide a clear and concise description of what the feature is which you'd like to see implemented. -->
+
+## Describe the solution you'd like
+<!--
+A clear and concise description of what you want to happen.
+
+Please include some code samples of what should be flagged and preferably also some
+code samples of what should *not* be flagged.
+-->
+
+## Additional context (optional)
+<!-- Add any other context or screenshots about the feature request here. -->
+
+- [ ] I intend to create a pull request to implement this feature.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 0000000..f36d0ed
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,32 @@
+<!-- Provide a general summary of your changes in the title above. -->
+
+# Description
+<!--
+What do you want to achieve with this PR? What problem does this PR solve?
+Describe your changes in detail and, if relevant, explain which choices you have made and why.
+-->
+
+
+## Related issues/external references
+
+Fixes #
+
+
+## PR checklist
+<!-- Go over all the following points, and put an `x` in all the boxes that apply. -->
+- [ ] I have checked there is no other PR open for the same change.
+- [ ] I have read the [Contribution Guidelines](https://github.com/PHPCSStandards/PHP_CodeSniffer-documentation/blob/main/CONTRIBUTING.md).
+- [ ] I grant the project the right to include my changes under the BSD-3-Clause license (and I have the right to grant these rights).
+- [ ] I have verified that the code complies with the projects coding standards.
+- [ ] [When adding a new Wiki page] I have added the new page to the `_Sidebar.md` file.
+
+<!--
+============================================================================================
+Please make sure your pull request passes all continuous integration checks!
+
+PRs which are failing their CI checks will likely be ignored by the maintainers.
+
+Small PRs using atomic, descriptive commits are hugely appreciated as it will make
+reviewing your changes easier for the maintainers.
+============================================================================================
+-->

From 80648d3bbe1dd7d6fb54e18582d6e287b9aecff8 Mon Sep 17 00:00:00 2001
From: jrfnl <jrfnl@users.noreply.github.com>
Date: Sun, 15 Jun 2025 11:41:47 +0200
Subject: [PATCH 5/5] GH Actions: add workflow to automatically deploy the wiki

---
 .github/workflows/deploy-to-wiki.yml | 15 +++++++++++++++
 .github/workflows/publish-wiki.yml   |  2 ++
 2 files changed, 17 insertions(+)
 create mode 100644 .github/workflows/deploy-to-wiki.yml

diff --git a/.github/workflows/deploy-to-wiki.yml b/.github/workflows/deploy-to-wiki.yml
new file mode 100644
index 0000000..a5ab62b
--- /dev/null
+++ b/.github/workflows/deploy-to-wiki.yml
@@ -0,0 +1,15 @@
+
+
+Automatically add the following at the top of each file:
+
+```
+<!--
+DO NOT EDIT THIS FILE IN THE WIKI.
+This wiki is updated from the https://github.com/PHPCSStandards/PHP_CodeSniffer-documentation repo.
+Submit a PR to that repo updating the file in the `/wiki/` subdirectory instead.
+-->
+```
+
+
+Automatically replace output example placeholders with real output
+
diff --git a/.github/workflows/publish-wiki.yml b/.github/workflows/publish-wiki.yml
index b15ee47..ef9df2e 100644
--- a/.github/workflows/publish-wiki.yml
+++ b/.github/workflows/publish-wiki.yml
@@ -104,6 +104,8 @@ jobs:
       - name: Re-run tables of contents with different settings for specific file
         run: doctoc ./_wiki/Version-4.0-User-Upgrade-Guide.md --github --maxlevel 3 --update-only
 
+      # TODO:
+      # Update output examples
 
       # ############################
       # Deploy.