From b6476068250953cd5ed6f6f0530187f4fac45483 Mon Sep 17 00:00:00 2001 From: Justin Frydman Date: Mon, 20 Feb 2023 11:57:51 -0700 Subject: [PATCH] Update docs to instruct the user to enable composer patching in their project --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0412f00..c468de7 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Modern Tribe Coding Standards -The Modern Tribe Coding Standard is a set of [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) +The Modern Tribe Coding Standard is a set of [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) rules for use primarily with the [SquareOne](https://github.com/moderntribe/square-one) framework. ## Requirements @@ -32,6 +32,14 @@ And `require-dev`: "moderntribe/coding-standards": "^3.0" ``` +Ensure to enable composer patching in your project's composer.json to fix broken PHPCS rules: + +```json +"extra": { + "enable-patching": true +} +``` + ## Project ruleset > Ensure you're running PHP 8.0 locally! @@ -77,7 +85,7 @@ To use this ruleset, create a `phpcs.xml.dist` in the root of the project and ad ``` > Add `phpcs.xml` to your `.gitignore` - + ## Manual Usage **PHPCS**