From dce34402dd012b627fb46591c5e331dd15bd96a8 Mon Sep 17 00:00:00 2001 From: Alex Date: Sun, 26 Jul 2026 10:42:46 +0300 Subject: [PATCH] Document in-portal branch's ruleset customizations in README Explains the exclude-patterns and severity overrides that differ from master so it's clear these are intentional, project-specific opt-outs. Co-Authored-By: Claude Sonnet 5 --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 541cc8e..72d6f2c 100644 --- a/README.md +++ b/README.md @@ -19,3 +19,16 @@ Only PHP_CodeSniffer 3.x and later versions are supported. For PHP_CodeSniffer 1 $> phpcs --standard="/path/to/CodingStandard/CodingStandard" library tests ``` or by make your IDE ([instructions for PhpStorm](http://www.jetbrains.com/phpstorm/webhelp/using-php-code-sniffer-tool.html)) to check them automatically. + +# Branch-specific Customizations + +This branch is kept in sync with `master` (periodically merged) and additionally carries a few `ruleset.xml` +customizations specific to the In-Portal project: + +* excludes `blog/*`, `build/*`, `core/editor/*`, `core/ckeditor/*`, `modules/mpdf/*`, `system/*` and `vendor/*` from + scanning entirely +* disables `Generic.WhiteSpace.ScopeIndent.IncorrectExact` under `/core/`, since it produces excessive noise there +* disables `CodingStandard.Classes.ClassNamespace.MissingNamespace`, since a lot of the project's code predates + namespaces + +No sniff behavior differs otherwise — these are ruleset-level opt-outs, not code changes.