<script language="JavaScript">
<!--
function _AN_global_var_init(){
	_AN_this_url = "/prx/000/";
	_AN_base_scheme = "https";
	_AN_base_host = "https://patch-diff.githubusercontent.com";
	_AN_base_path = "https://patch-diff.githubusercontent.com/raw/PHPCSStandards/PHP_CodeSniffer-documentation/pull/";
	_AN_encode_urls = 0;
	_AN_mpo = 1;
	_AN_md = 0;
	_AN_rel_urls = 1;
	_AN_nav_switch = 0;
	_AN_nav_allowurl = 1;
	_AN_nav_override = 0;
	_AN_has_iframe = 0;
	_AN_dbg_flags = null;
	_AN_nav_use_aaa = 1;
	_AN_expires_pass = 0;
	_AN_wrap_evthandlers = 0;
	_AN_rewrite_param_exact = 0;
	_AN_obj_params = {};
} 
_AN_global_var_init();
//-->
</script>
<script language="JavaScript" src="/prx/001/http/localh/an_util.js"></script>
<script language="JavaScript" src="/prx/001/http/localh/NSLib.js"></script>

From ff5b599946bba6430213f484317773ba33366c48 Mon Sep 17 00:00:00 2001
From: jrfnl <jrfnl@users.noreply.github.com>
Date: Sun, 13 Jul 2025 09:07:10 +0200
Subject: [PATCH 01/19] Add CONTRIBUTING guide

This commit tries to add comprehensive information about contributing to the PHP_CodeSniffer wiki documentation, including information about what pre-processing is executed and information about running the QA checks run in CI, locally.
---
 .cspell.yml                      |   5 ++
 .github/pull_request_template.md |  41 ++++++++++
 CONTRIBUTING.md                  | 125 +++++++++++++++++++++++++++++++
 README.md                        |   5 ++
 4 files changed, 176 insertions(+)
 create mode 100644 .github/pull_request_template.md
 create mode 100644 CONTRIBUTING.md

diff --git a/.cspell.yml b/.cspell.yml
index 4af5060..26ff0f4 100644
--- a/.cspell.yml
+++ b/.cspell.yml
@@ -51,3 +51,8 @@ words:
 
   # Used in Wiki Reporting page, "emacs" file.
   - defun
+
+  # Used in CONTRIBUTING.
+  - maxlevel
+  - replacer
+  - Shellcheck
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 0000000..53fc2ff
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,41 @@
+<!-- Provide a general summary of your changes in the title above. -->
+
+<!--
+IMPORTANT:
+PRs should be small and atomic and should only focus on one thing.
+There should generally only be one commit per PR for changes to the Wiki.
+
+If your PR is making multiple distinct changes, please split it now and submit multiple PRs instead.
+-->
+
+# 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 my changes comply with the projects coding standards.
+- [ ] \[When adding a new Wiki page\] I have added the new page to the `_Sidebar.md` file.
+- [ ] \[When adding/updating output examples\] I have verified via the GitHub Actions artifact that the preprocessing handles the command correctly.
+
+<!--
+============================================================================================
+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.
+============================================================================================
+-->
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..8b2486a
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,125 @@
+# 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).
+
+### 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 in this repository to the upstream Wiki repo.
+* Prior to pushing the changes, the workflow will pre-process the files and make the following changes:
+    * Replace `{{COMMAND-OUTPUT ...}}` command-line output placeholders with actual command-line output from either `phpcs` or `phpcbf`.
+        The code samples used for generating some of this output can be found in the `build/wiki/code-samples` directory.
+    * Replace `<!-- START doctoc --> <!-- END doctoc -->` placeholders with a Table of Contents for the page in Markdown.
+    * Add a prominent (hidden) warning at the top of each wiki file to warn people against editing the wiki files via the GitHub wiki editing interface.
+
+
+### Contributing to the Wiki
+
+If you would like to improve the documentation:
+1. Fork this repository.
+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.
+7. Please ensure your pull requests passes all automated quality checks.
+8. If you updated anything which will be auto-replaced via the preprocessing:
+    * The GitHub Actions workflow will do a "dry-run" for every PR (pre-process only, no push to the wiki).
+    * Please download the artifact which was created via this dry-run and verify the preprocessing replaced the output in the way you expected.
+
+When in doubt, open an issue first to discuss your change proposal.
+
+
+### Guidelines for updating the wiki files
+
+* Small PRs fixing only one thing will be better received than larger PRs fixing a lot of things in one go.
+* 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.
+* Add table of contents markers if appropriate.
+    The start of a page containing a table of contents should look like this:
+    ```md
+    ## Table of contents
+
+    <!-- START doctoc -->
+    <!-- END doctoc -->
+
+    ***
+
+    ... the actual page ...
+    ```
+* Regarding command replacement markers ...
+    * A marker MUST look like `{{COMMAND-OUTPUT ...}}` with `...` being replacement with a quoted `phpcs` or `phpcbf` command.
+    * A marker MUST be at the start of a line.
+    * A marker MUST be on a line by itself.
+    * Commands will be run from the project root directory. Keep this in mind when adding a command replacement marker to a wiki file.
+* The command replacement will not add markdown code fence syntax, so make sure to do this yourself.
+* If a code sample is needed to generate the desired output, place the code sample in a file in the `build/wiki-code-samples` directory.
+
+
+#### Running the pre-processing locally
+
+As noted above, you don't _need_ to run the pre-processing locally, a dry-run will be done via GitHub Actions for each PR.
+However, if you are making extensive changes, you may still want to test things locally before submitting your PR.
+
+> [!IMPORTANT]
+> Run the bash script first, only run the TOC replacement after.
+
+The bash script used for the command replacements can be run locally from the project root directory by invoking:
+
+```bash
+build/wiki-command-replacer.sh
+```
+
+Notes:
+* For the bash script to succeed, the `phpcs` and `phpcbf` commands need to be available in the `PATH` for your OS.
+* The bash script will copy the wiki files to the `_wiki` directory before making any replacements to prevent anyone accidentally committing the processed files.
+
+The table of contents generation can be tested locally by installing the `doctoc` tool and running this locally like so:
+
+```bash
+npm install -g doctoc
+doctoc ./_wiki/ --github --maxlevel 4 --update-only
+doctoc ./_wiki/Version-4.0-User-Upgrade-Guide.md --github --maxlevel 3 --update-only
+```
+
+Note that this presumes the command replacer has already run and the files have already been copied to the `_wiki` directory.
+
+If you only want to test the TOC generation, make sure you copy the wiki files to the `_wiki` directory before running these commands.
+
+
+#### Running code quality checks locally
+
+All used code quality checks can be run locally.
+Configuration files have been committed to the repository to ensure you will locally get the same results as when the tooling runs in CI.
+
+To run the quality checks locally, install the following tooling:
+* [Yamllint](https://github.com/adrienverge/yamllint)
+    * [Installation instructions](https://yamllint.readthedocs.io/en/stable/quickstart.html)
+    * Run it like so: `yamllint . --format colored --strict --list-files`
+* [Actionlint](https://github.com/rhysd/actionlint)
+    * [Installation instructions](https://github.com/rhysd/actionlint/blob/main/docs/install.md)
+    * Run it like so: `actionlint -verbose`
+* [Markdownlint-cli2](https://github.com/DavidAnson/markdownlint-cli2)
+    * [Installation instructions](https://github.com/DavidAnson/markdownlint-cli2#install)
+    * Run it like so: `markdownlint-cli2`
+* [Lychee](https://github.com/lycheeverse/lychee)
+    * [Installation instructions](https://github.com/lycheeverse/lychee?tab=readme-ov-file#installation)
+    * Run it like so: `lychee "./**/*.md"`
+        Note: this command will show "false positives" locally for the `_Sidebar.md` file. These can be ignored.
+* [CSpell](https://cspell.org/)
+    * [Installation instructions](https://cspell.org/docs/installation)
+    * Run it like so: `cspell "**/*.md"`
+* [Shellcheck](https://www.shellcheck.net/)
+    * [Installation instructions](https://github.com/koalaman/shellcheck?tab=readme-ov-file#installing)
+    * Run it like so: `shellcheck ./build/wiki-command-replacer.sh`
+
+
+### 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 repository, 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 dd4606e36548e06b1fca4b304f0ac7daaf3b6fbc Mon Sep 17 00:00:00 2001
From: jrfnl <jrfnl@users.noreply.github.com>
Date: Tue, 15 Jul 2025 16:48:56 +0200
Subject: [PATCH 02/19] [SQUASH-ME] Add TOC to CONTRIBUTING + back to top links

---
 CONTRIBUTING.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 8b2486a..a096615 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,5 +1,17 @@
 # Contributing to the PHP_CodeSniffer documentation
 
+## Table of Contents
+
+* [PHP_CodeSniffer Wiki](#php_codesniffer-wiki)
+    * [How does the wiki get updated ?](#how-does-the-wiki-get-updated-)
+    * [Contributing to the Wiki](#contributing-to-the-wiki)
+    * [Guidelines for updating the wiki files](#guidelines-for-updating-the-wiki-files)
+        * [Running the pre-processing locally](#running-the-pre-processing-locally)
+        * [Running code quality checks locally](#running-code-quality-checks-locally)
+    * [Frequently Asked Questions](#frequently-asked-questions)
+        * [Why not make the Wiki publicly editable ?](#why-not-make-the-wiki-publicly-editable-)
+
+
 ## 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).
@@ -14,6 +26,8 @@ For now, the documentation for the PHP_CodeSniffer project is available via the
     * Replace `<!-- START doctoc --> <!-- END doctoc -->` placeholders with a Table of Contents for the page in Markdown.
     * Add a prominent (hidden) warning at the top of each wiki file to warn people against editing the wiki files via the GitHub wiki editing interface.
 
+<p align="right"><a href="#table-of-contents">back to top</a></p>
+
 
 ### Contributing to the Wiki
 
@@ -31,6 +45,8 @@ If you would like to improve the documentation:
 
 When in doubt, open an issue first to discuss your change proposal.
 
+<p align="right"><a href="#table-of-contents">back to top</a></p>
+
 
 ### Guidelines for updating the wiki files
 
@@ -56,6 +72,8 @@ When in doubt, open an issue first to discuss your change proposal.
 * The command replacement will not add markdown code fence syntax, so make sure to do this yourself.
 * If a code sample is needed to generate the desired output, place the code sample in a file in the `build/wiki-code-samples` directory.
 
+<p align="right"><a href="#table-of-contents">back to top</a></p>
+
 
 #### Running the pre-processing locally
 
@@ -87,6 +105,8 @@ Note that this presumes the command replacer has already run and the files have
 
 If you only want to test the TOC generation, make sure you copy the wiki files to the `_wiki` directory before running these commands.
 
+<p align="right"><a href="#table-of-contents">back to top</a></p>
+
 
 #### Running code quality checks locally
 
@@ -114,6 +134,8 @@ To run the quality checks locally, install the following tooling:
     * [Installation instructions](https://github.com/koalaman/shellcheck?tab=readme-ov-file#installing)
     * Run it like so: `shellcheck ./build/wiki-command-replacer.sh`
 
+<p align="right"><a href="#table-of-contents">back to top</a></p>
+
 
 ### Frequently Asked Questions
 
@@ -123,3 +145,5 @@ Publicly editable Wiki pages for big projects get vandalized pretty often and we
 
 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 repository, it allows for automating certain updates which would otherwise have to be done manually.
+
+<p align="right"><a href="#table-of-contents">back to top</a></p>

From 8d79d736ef9ca9344970a4eb8a16dd6f928dba61 Mon Sep 17 00:00:00 2001
From: Juliette <663378+jrfnl@users.noreply.github.com>
Date: Tue, 15 Jul 2025 17:10:14 +0200
Subject: [PATCH 03/19] [SQUASH-ME] Update CONTRIBUTING.md

Co-authored-by: Anna Filina <afilina@gmail.com>
---
 CONTRIBUTING.md | 9 +++------
 1 file changed, 3 insertions(+), 6 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index a096615..b3ee4fb 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -19,12 +19,9 @@ For now, the documentation for the PHP_CodeSniffer project is available via the
 ### 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 in this repository to the upstream Wiki repo.
-* Prior to pushing the changes, the workflow will pre-process the files and make the following changes:
-    * Replace `{{COMMAND-OUTPUT ...}}` command-line output placeholders with actual command-line output from either `phpcs` or `phpcbf`.
-        The code samples used for generating some of this output can be found in the `build/wiki/code-samples` directory.
-    * Replace `<!-- START doctoc --> <!-- END doctoc -->` placeholders with a Table of Contents for the page in Markdown.
-    * Add a prominent (hidden) warning at the top of each wiki file to warn people against editing the wiki files via the GitHub wiki editing interface.
+* A [GitHub Actions workflow](https://github.com/PHPCSStandards/PHP_CodeSniffer-documentation/blob/main/.github/workflows/publish-wiki.yml) was added:
+    * It pre-processes the `.md` files to replace placeholders and inject some other content (see [Guidelines for updating the wiki files](#guidelines-for-updating-the-wiki-files)).
+    * And then it pushes the resulting updated `.md` files to the upstream Wiki repo.
 
 <p align="right"><a href="#table-of-contents">back to top</a></p>
 

From efe31c706841ce311011aefbffcfc41d0d0b2172 Mon Sep 17 00:00:00 2001
From: Juliette <663378+jrfnl@users.noreply.github.com>
Date: Tue, 15 Jul 2025 17:10:58 +0200
Subject: [PATCH 04/19] [SQUASH-ME] Update CONTRIBUTING.md

Co-authored-by: Anna Filina <afilina@gmail.com>
---
 CONTRIBUTING.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index b3ee4fb..6798b9e 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -34,7 +34,7 @@ If you would like to improve the documentation:
 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.
+6. Submit a pull request from your fork to this repository. This process is documented in more detail in the [GitHub Docs](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork).
 7. Please ensure your pull requests passes all automated quality checks.
 8. If you updated anything which will be auto-replaced via the preprocessing:
     * The GitHub Actions workflow will do a "dry-run" for every PR (pre-process only, no push to the wiki).

From 17f8bfa099620b895da14a2a0fa08cbfd74f5ab7 Mon Sep 17 00:00:00 2001
From: Juliette <663378+jrfnl@users.noreply.github.com>
Date: Tue, 15 Jul 2025 17:11:42 +0200
Subject: [PATCH 05/19] [SQUASH-ME] Update CONTRIBUTING.md

Co-authored-by: Anna Filina <afilina@gmail.com>
---
 CONTRIBUTING.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 6798b9e..5a44c88 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -38,7 +38,7 @@ If you would like to improve the documentation:
 7. Please ensure your pull requests passes all automated quality checks.
 8. If you updated anything which will be auto-replaced via the preprocessing:
     * The GitHub Actions workflow will do a "dry-run" for every PR (pre-process only, no push to the wiki).
-    * Please download the artifact which was created via this dry-run and verify the preprocessing replaced the output in the way you expected.
+    * Please download the artifact which was created via this dry-run and verify the pre-processing replaced the output in the way you expected.
 
 When in doubt, open an issue first to discuss your change proposal.
 

From 6b1263cceff86ab22af8d3da6193eb7f8acad082 Mon Sep 17 00:00:00 2001
From: Juliette <663378+jrfnl@users.noreply.github.com>
Date: Tue, 15 Jul 2025 17:12:02 +0200
Subject: [PATCH 06/19] [SQUASH-ME] Update CONTRIBUTING.md

Co-authored-by: Anna Filina <afilina@gmail.com>
---
 CONTRIBUTING.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 5a44c88..e436696 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -36,7 +36,7 @@ If you would like to improve the documentation:
 5. Push your changes to your fork.
 6. Submit a pull request from your fork to this repository. This process is documented in more detail in the [GitHub Docs](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork).
 7. Please ensure your pull requests passes all automated quality checks.
-8. If you updated anything which will be auto-replaced via the preprocessing:
+8. If you updated anything which will be auto-replaced via the pre-processing:
     * The GitHub Actions workflow will do a "dry-run" for every PR (pre-process only, no push to the wiki).
     * Please download the artifact which was created via this dry-run and verify the pre-processing replaced the output in the way you expected.
 

From b340b54da96b18dd23bf148e2422a847795e4e2a Mon Sep 17 00:00:00 2001
From: Juliette <663378+jrfnl@users.noreply.github.com>
Date: Tue, 15 Jul 2025 17:12:15 +0200
Subject: [PATCH 07/19] [SQUASH-ME] Update .github/pull_request_template.md

Co-authored-by: Anna Filina <afilina@gmail.com>
---
 .github/pull_request_template.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index 53fc2ff..65c4e94 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -27,7 +27,7 @@ Fixes #
 - [ ] 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 my changes comply with the projects coding standards.
 - [ ] \[When adding a new Wiki page\] I have added the new page to the `_Sidebar.md` file.
-- [ ] \[When adding/updating output examples\] I have verified via the GitHub Actions artifact that the preprocessing handles the command correctly.
+- [ ] \[When adding/updating output examples\] I have verified via the GitHub Actions artifact that the pre-processing handles the command correctly.
 
 <!--
 ============================================================================================

From e1589dbd477d9079a54d44a2e97d7ee754d75990 Mon Sep 17 00:00:00 2001
From: Juliette <663378+jrfnl@users.noreply.github.com>
Date: Tue, 15 Jul 2025 17:14:39 +0200
Subject: [PATCH 08/19] [SQUASH-ME] Update CONTRIBUTING.md

Co-authored-by: Anna Filina <afilina@gmail.com>
---
 CONTRIBUTING.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index e436696..a16944c 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -45,7 +45,7 @@ When in doubt, open an issue first to discuss your change proposal.
 <p align="right"><a href="#table-of-contents">back to top</a></p>
 
 
-### Guidelines for updating the wiki files
+### Guidelines for Updating the Wiki Files
 
 * Small PRs fixing only one thing will be better received than larger PRs fixing a lot of things in one go.
 * 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.

From de463cd8d6d3a07ec8ee92d2f76a638e25684be3 Mon Sep 17 00:00:00 2001
From: Juliette <663378+jrfnl@users.noreply.github.com>
Date: Tue, 15 Jul 2025 17:14:49 +0200
Subject: [PATCH 09/19] [SQUASH-ME] Update CONTRIBUTING.md

Co-authored-by: Anna Filina <afilina@gmail.com>
---
 CONTRIBUTING.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index a16944c..d347f34 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -16,7 +16,7 @@
 
 For now, the documentation for the PHP_CodeSniffer project is available via the [project Wiki](https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki).
 
-### How does the wiki get updated ?
+### 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:

From cc2b93a361a5f48be272d919993e711c6611ac5a Mon Sep 17 00:00:00 2001
From: Juliette <663378+jrfnl@users.noreply.github.com>
Date: Tue, 15 Jul 2025 17:14:57 +0200
Subject: [PATCH 10/19] [SQUASH-ME] Update CONTRIBUTING.md

Co-authored-by: Anna Filina <afilina@gmail.com>
---
 CONTRIBUTING.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index d347f34..25ea608 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,4 +1,4 @@
-# Contributing to the PHP_CodeSniffer documentation
+# Contributing to the PHP_CodeSniffer Documentation
 
 ## Table of Contents
 

From b2f6a770608dc67cc6c88111a42275effdc49c4b Mon Sep 17 00:00:00 2001
From: Juliette <663378+jrfnl@users.noreply.github.com>
Date: Tue, 15 Jul 2025 17:15:50 +0200
Subject: [PATCH 11/19] [SQUASH-ME] Update CONTRIBUTING.md

Co-authored-by: Anna Filina <afilina@gmail.com>
---
 CONTRIBUTING.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 25ea608..ffe7759 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -105,7 +105,7 @@ If you only want to test the TOC generation, make sure you copy the wiki files t
 <p align="right"><a href="#table-of-contents">back to top</a></p>
 
 
-#### Running code quality checks locally
+#### Running Code Quality Checks Locally
 
 All used code quality checks can be run locally.
 Configuration files have been committed to the repository to ensure you will locally get the same results as when the tooling runs in CI.

From 4321eb6cdb824271e77811314e78dd741151f748 Mon Sep 17 00:00:00 2001
From: Juliette <663378+jrfnl@users.noreply.github.com>
Date: Tue, 15 Jul 2025 17:16:08 +0200
Subject: [PATCH 12/19] [SQUASH-ME] Update CONTRIBUTING.md

Co-authored-by: Anna Filina <afilina@gmail.com>
---
 CONTRIBUTING.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index ffe7759..41fcc0f 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -136,7 +136,7 @@ To run the quality checks locally, install the following tooling:
 
 ### Frequently Asked Questions
 
-#### Why not make the Wiki publicly editable ?
+#### 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.
 

From 3ac24ef0a07132591bc199c4d0cee8ab2f20a5bd Mon Sep 17 00:00:00 2001
From: jrfnl <jrfnl@users.noreply.github.com>
Date: Tue, 15 Jul 2025 17:18:48 +0200
Subject: [PATCH 13/19] [SQUASH-ME] Title case for "Wiki"

---
 CONTRIBUTING.md | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 41fcc0f..a521252 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -3,7 +3,7 @@
 ## Table of Contents
 
 * [PHP_CodeSniffer Wiki](#php_codesniffer-wiki)
-    * [How does the wiki get updated ?](#how-does-the-wiki-get-updated-)
+    * [How does the Wiki get updated ?](#how-does-the-wiki-get-updated-)
     * [Contributing to the Wiki](#contributing-to-the-wiki)
     * [Guidelines for updating the wiki files](#guidelines-for-updating-the-wiki-files)
         * [Running the pre-processing locally](#running-the-pre-processing-locally)
@@ -20,7 +20,7 @@ For now, the documentation for the PHP_CodeSniffer project is available via the
 
 * 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:
-    * It pre-processes the `.md` files to replace placeholders and inject some other content (see [Guidelines for updating the wiki files](#guidelines-for-updating-the-wiki-files)).
+    * It pre-processes the `.md` files to replace placeholders and inject some other content (see [Guidelines for Updating the Wiki Files](#guidelines-for-updating-the-wiki-files)).
     * And then it pushes the resulting updated `.md` files to the upstream Wiki repo.
 
 <p align="right"><a href="#table-of-contents">back to top</a></p>
@@ -37,7 +37,7 @@ If you would like to improve the documentation:
 6. Submit a pull request from your fork to this repository. This process is documented in more detail in the [GitHub Docs](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork).
 7. Please ensure your pull requests passes all automated quality checks.
 8. If you updated anything which will be auto-replaced via the pre-processing:
-    * The GitHub Actions workflow will do a "dry-run" for every PR (pre-process only, no push to the wiki).
+    * The GitHub Actions workflow will do a "dry-run" for every PR (pre-process only, no push to the Wiki).
     * Please download the artifact which was created via this dry-run and verify the pre-processing replaced the output in the way you expected.
 
 When in doubt, open an issue first to discuss your change proposal.
@@ -48,7 +48,7 @@ When in doubt, open an issue first to discuss your change proposal.
 ### Guidelines for Updating the Wiki Files
 
 * Small PRs fixing only one thing will be better received than larger PRs fixing a lot of things in one go.
-* 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.
+* 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.
 * Add table of contents markers if appropriate.
     The start of a page containing a table of contents should look like this:
     ```md
@@ -65,7 +65,7 @@ When in doubt, open an issue first to discuss your change proposal.
     * A marker MUST look like `{{COMMAND-OUTPUT ...}}` with `...` being replacement with a quoted `phpcs` or `phpcbf` command.
     * A marker MUST be at the start of a line.
     * A marker MUST be on a line by itself.
-    * Commands will be run from the project root directory. Keep this in mind when adding a command replacement marker to a wiki file.
+    * Commands will be run from the project root directory. Keep this in mind when adding a command replacement marker to a Wiki file.
 * The command replacement will not add markdown code fence syntax, so make sure to do this yourself.
 * If a code sample is needed to generate the desired output, place the code sample in a file in the `build/wiki-code-samples` directory.
 
@@ -88,7 +88,7 @@ build/wiki-command-replacer.sh
 
 Notes:
 * For the bash script to succeed, the `phpcs` and `phpcbf` commands need to be available in the `PATH` for your OS.
-* The bash script will copy the wiki files to the `_wiki` directory before making any replacements to prevent anyone accidentally committing the processed files.
+* The bash script will copy the Wiki files to the `_wiki` directory before making any replacements to prevent anyone accidentally committing the processed files.
 
 The table of contents generation can be tested locally by installing the `doctoc` tool and running this locally like so:
 
@@ -100,7 +100,7 @@ doctoc ./_wiki/Version-4.0-User-Upgrade-Guide.md --github --maxlevel 3 --update-
 
 Note that this presumes the command replacer has already run and the files have already been copied to the `_wiki` directory.
 
-If you only want to test the TOC generation, make sure you copy the wiki files to the `_wiki` directory before running these commands.
+If you only want to test the TOC generation, make sure you copy the Wiki files to the `_wiki` directory before running these commands.
 
 <p align="right"><a href="#table-of-contents">back to top</a></p>
 
@@ -140,7 +140,7 @@ To run the quality checks locally, install the following tooling:
 
 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 repository, it allows for automating certain updates which would otherwise have to be done manually.
+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 repository, it allows for automating certain updates which would otherwise have to be done manually.
 
 <p align="right"><a href="#table-of-contents">back to top</a></p>

From 253102e7b72b558214802111f1e303d7bd9c013c Mon Sep 17 00:00:00 2001
From: Juliette <663378+jrfnl@users.noreply.github.com>
Date: Tue, 15 Jul 2025 17:19:37 +0200
Subject: [PATCH 14/19] [SQUASH-ME] Update CONTRIBUTING.md

Co-authored-by: Anna Filina <afilina@gmail.com>
---
 CONTRIBUTING.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index a521252..9e7b691 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -52,7 +52,7 @@ When in doubt, open an issue first to discuss your change proposal.
 * Add table of contents markers if appropriate.
     The start of a page containing a table of contents should look like this:
     ```md
-    ## Table of contents
+    ## Table of Contents
 
     <!-- START doctoc -->
     <!-- END doctoc -->

From b0961f2d82780111a277c2f0374df2634b67bcf9 Mon Sep 17 00:00:00 2001
From: jrfnl <jrfnl@users.noreply.github.com>
Date: Tue, 15 Jul 2025 17:21:32 +0200
Subject: [PATCH 15/19] [SQUASH-ME] Clarify fully qualified links

---
 CONTRIBUTING.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 9e7b691..1a32030 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -48,7 +48,7 @@ When in doubt, open an issue first to discuss your change proposal.
 ### Guidelines for Updating the Wiki Files
 
 * Small PRs fixing only one thing will be better received than larger PRs fixing a lot of things in one go.
-* 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.
+* Always use absolute links (https://...). 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.
 * Add table of contents markers if appropriate.
     The start of a page containing a table of contents should look like this:
     ```md

From adcaefe5e7e8c9e619b57d89b69fcbae198bfa48 Mon Sep 17 00:00:00 2001
From: Juliette <663378+jrfnl@users.noreply.github.com>
Date: Tue, 15 Jul 2025 17:22:12 +0200
Subject: [PATCH 16/19] [SQUASH-ME] Update CONTRIBUTING.md

Co-authored-by: Anna Filina <afilina@gmail.com>
---
 CONTRIBUTING.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 1a32030..7c13dd5 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -61,7 +61,7 @@ When in doubt, open an issue first to discuss your change proposal.
 
     ... the actual page ...
     ```
-* Regarding command replacement markers ...
+* Guidelines for command replacement placeholders:
     * A marker MUST look like `{{COMMAND-OUTPUT ...}}` with `...` being replacement with a quoted `phpcs` or `phpcbf` command.
     * A marker MUST be at the start of a line.
     * A marker MUST be on a line by itself.

From c9454dd8ca3f502fbd38528d73e9478358177a6e Mon Sep 17 00:00:00 2001
From: jrfnl <jrfnl@users.noreply.github.com>
Date: Tue, 15 Jul 2025 17:23:58 +0200
Subject: [PATCH 17/19] [SQUASH-ME] Update table of contents

---
 CONTRIBUTING.md | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 7c13dd5..9f41055 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -3,13 +3,13 @@
 ## Table of Contents
 
 * [PHP_CodeSniffer Wiki](#php_codesniffer-wiki)
-    * [How does the Wiki get updated ?](#how-does-the-wiki-get-updated-)
+    * [How Does the Wiki Get Updated?](#how-does-the-wiki-get-updated)
     * [Contributing to the Wiki](#contributing-to-the-wiki)
-    * [Guidelines for updating the wiki files](#guidelines-for-updating-the-wiki-files)
+    * [Guidelines for Updating the Wiki Files](#guidelines-for-updating-the-wiki-files)
         * [Running the pre-processing locally](#running-the-pre-processing-locally)
-        * [Running code quality checks locally](#running-code-quality-checks-locally)
+        * [Running Code Quality Checks Locally](#running-code-quality-checks-locally)
     * [Frequently Asked Questions](#frequently-asked-questions)
-        * [Why not make the Wiki publicly editable ?](#why-not-make-the-wiki-publicly-editable-)
+        * [Why Not Make the Wiki Publicly Editable?](#why-not-make-the-wiki-publicly-editable)
 
 
 ## PHP_CodeSniffer Wiki

From f5e974923871e865f7763ec181677ee96c566a98 Mon Sep 17 00:00:00 2001
From: Juliette <663378+jrfnl@users.noreply.github.com>
Date: Tue, 15 Jul 2025 17:29:03 +0200
Subject: [PATCH 18/19] [SQUASH-ME] Update CONTRIBUTING.md

Co-authored-by: Anna Filina <afilina@gmail.com>
---
 CONTRIBUTING.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 9f41055..63691d6 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -49,7 +49,7 @@ When in doubt, open an issue first to discuss your change proposal.
 
 * Small PRs fixing only one thing will be better received than larger PRs fixing a lot of things in one go.
 * Always use absolute links (https://...). 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.
-* Add table of contents markers if appropriate.
+* Add table of contents placeholders if appropriate.
     The start of a page containing a table of contents should look like this:
     ```md
     ## Table of Contents

From c97e4c5216d0e2fa9817a1c4efc3e6939bc437b5 Mon Sep 17 00:00:00 2001
From: Juliette <663378+jrfnl@users.noreply.github.com>
Date: Tue, 15 Jul 2025 17:29:51 +0200
Subject: [PATCH 19/19] [SQUASH-ME] Update CONTRIBUTING.md

Co-authored-by: Anna Filina <afilina@gmail.com>
---
 CONTRIBUTING.md | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 63691d6..12696fb 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -62,10 +62,10 @@ When in doubt, open an issue first to discuss your change proposal.
     ... the actual page ...
     ```
 * Guidelines for command replacement placeholders:
-    * A marker MUST look like `{{COMMAND-OUTPUT ...}}` with `...` being replacement with a quoted `phpcs` or `phpcbf` command.
-    * A marker MUST be at the start of a line.
-    * A marker MUST be on a line by itself.
-    * Commands will be run from the project root directory. Keep this in mind when adding a command replacement marker to a Wiki file.
+    * A placeholder MUST look like `{{COMMAND-OUTPUT ...}}` with `...` replaced with a quoted `phpcs` or `phpcbf` command. Example: `{{COMMAND-OUTPUT "phpcbf --report-width=110 --no-colors -h"}}`
+    * A placeholder MUST be at the start of a line.
+    * A placeholder MUST be on a line by itself.
+    * Commands will be run from the project root directory. Keep this in mind when adding a placeholder to a Wiki file.
 * The command replacement will not add markdown code fence syntax, so make sure to do this yourself.
 * If a code sample is needed to generate the desired output, place the code sample in a file in the `build/wiki-code-samples` directory.
 
