Skip to content

Commit

Permalink
Update docs to instruct the user to enable composer patching in their…
Browse files Browse the repository at this point in the history
… project
  • Loading branch information
defunctl committed Feb 20, 2023
1 parent 293a47d commit b647606
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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!
Expand Down Expand Up @@ -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**
Expand Down

0 comments on commit b647606

Please sign in to comment.