chore: update example with cache, severity, comments

Author: justlevine

CHANGELOG.md

@@ -6,6 +6,7 @@ This projects adheres to [Semantic Versioning](https://semver.org/) and [Keep a
 
 ## [Unreleased]
 - dev: Remove `Squiz.Commenting.FunctionComment.ParamCommentFullStop` and `Squiz.Commenting.FunctionComment.EmptyThrows` from `WPGraphQL-Strict`.
+- chore: Update `phpcs.xml.dist.example` to set the `cache` and `severity` values, and add additional inline-comments.
 
 ## [1.0.0-beta.1] - 2023-06-05
 - Initial release

phpcs.xml.dist.example

@@ -15,14 +15,21 @@
 	<!-- How to scan: include CLI args so you don't need to pass them manually -->
 	<!-- Usage instructions: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Usage -->
 	<!-- Annotated ruleset: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-ruleset.xml -->
-	<arg value="sp"/>
+
 	<!-- Show sniff and progress -->
-	<arg name="basepath" value="./"/>
+	<arg value="sp"/>
 	<!-- Strip the file paths down to the relevant bit -->
+	<arg name="basepath" value="./"/>
+	<!-- Enable colors in report -->
 	<arg name="colors"/>
+	<!-- Only lint php files by default -->
 	<arg name="extensions" value="php"/>
+	<!-- Whenever possible, cache the scan results and re-use those for unchanged files on the next scan. -->
+	<arg name="cache" value="tests/_output/cache.json" />
 	<!-- Enables parallel processing when available for faster results. -->
 	<arg name="parallel" value="20"/>
+	<!-- Set severity to 1 to see everything that isn't effectively turned off. -->
+	<arg name="severity" value="1" />
 
 	<!-- Ruleset Config: set these to match your project constraints-->