Skip to content

Document in-portal branch's ruleset customizations in README #118

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aik099 merged 1 commit into from
Jul 26, 2026
Merged

Document in-portal branch's ruleset customizations in README #118

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Loading