Wiki: always have filenames in backticks Hoping I've caught them all, but not claiming completeness.

github-actions[bot] committed Jul 15, 2025

Wiki: various grammar and spelling fixes

github-actions[bot] committed Jul 15, 2025

GH Actions: add a workflow to automatically deploy the wiki This commit introduces a workflow, which will: * Automatically deploy the wiki files to the [PHP_CodeSniffer repo wiki](https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki) on every push to the `main` branch. * Will do a dry-run, without actually deploying, whenever a PR is created which would update the wiki files. This way, the wiki is opened up to contributions via pull requests and is no longer limited to only edits made by committers. A prominent warning is automatically added as a (hidden) comment at the top of each wiki file to warn committers not to edit the wiki file in the GitHub wiki interface. Any edits made via the GitHub wiki interface or by directly pushing to the wiki repository, will be lost and overwritten via this workflow the next time a change is pushed to the `main` branch of this repo. This commit also adds a `_Footer.md` file, which will automatically be displayed at the bottom of each wiki page to point out that the wiki is editable via PRs to this repo. Notes: * The files are copied to a `_wiki` directory - which is `.gitignore`d - before pre-processing to reduce the risk of the source files being accidentally updated (and committed), which would undo the automation. * Commits for "push" events to the `main` branch will get the same commit message for the wiki as the _last_ commit on the `main` branch. For that reason, merge commits are not allowed in this repo and PRs with only one commit are strongly preferred. * Dry-run commits for PR events and commits triggered by other events, will get a simplified message referencing the sha of the last commit. * If the net effect of a commit results in no changes to the wiki files (CI changes and such), no commit will be made to the wiki. * The workflow is set up to fail if GitHub has an outage for git operations. That should protect the wiki from going down by a broken/partial commit and allows for retriggering a deploy once the outage has passed by re-running the failed build. Future scope (upcoming): * Automate generation of the Table of Contents for wiki pages. * Automate re-generation of output examples used in the wiki pages. Refs: * https://github.com/Andrew-Chen-Wang/github-wiki-action * https://github.com/crazy-max/ghaction-github-status

github-actions[bot] committed Jul 14, 2025

Annotated-Ruleset: fix typo

jrfnl committed Apr 4, 2025

Add new "About Standards" page This new page contains more generic information about: * The difference between a project ruleset and a standard. * Requirements for a standard. * Naming conventions for sniffs.

jrfnl committed Feb 5, 2025

Fix some grammar issues and typos

jrfnl committed Nov 12, 2023

Fix ruleset sample related to changing the message template (related to #3769)

jrfnl committed Oct 28, 2023

Updated Annotated Ruleset (markdown)

gsherwood committed May 11, 2020

Updated Annotated Ruleset (markdown)

gsherwood committed Dec 10, 2019

Updated Annotated Ruleset (markdown)

gsherwood committed Dec 8, 2019

Updated Annotated Ruleset (markdown)

gsherwood committed Jan 7, 2019

Updated Annotated Ruleset (markdown)

gsherwood committed Oct 23, 2018

Updated Annotated Ruleset (markdown)

gsherwood committed Oct 23, 2018

Updated Annotated Ruleset (markdown)

gsherwood committed Oct 23, 2018

Updated Annotated ruleset (markdown)

gsherwood committed Aug 16, 2018