-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
39 additions
and
32 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| # Contributing | ||
|
|
||
| [](https://github.com/cssllc/mu-plugins/actions/workflows/phpcs.yml) | ||
| [](https://github.com/cssllc/mu-plugins/actions/workflows/phpstan.yml) | ||
|
|
||
| ## Checks | ||
|
|
||
| There are two checks run on pull requests: | ||
|
|
||
| 1. PHPCS | ||
| 1. PHPStan | ||
|
|
||
| PHPCS and PHPStan are managed via Composer. | ||
|
|
||
| ### Setup | ||
|
|
||
| To setup the checks locally, run the install command with the root of the WordPress install (directory with `composer.json`): | ||
|
|
||
| ``` | ||
| composer install | ||
| ``` | ||
|
|
||
| ### Run | ||
|
|
||
| #### PHPCS | ||
|
|
||
| ``` | ||
| vendor/bin/phpcs | ||
| ``` | ||
|
|
||
| #### PHPStan | ||
|
|
||
| ``` | ||
| vendor/bin/phpstan --memory-limit=-1 | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,35 +1,7 @@ | ||
| # Contributing | ||
| # MU-Plugins | ||
|
|
||
| [](https://github.com/cssllc/mu-plugins/actions/workflows/phpcs.yml) | ||
| [](https://github.com/cssllc/mu-plugins/actions/workflows/phpstan.yml) | ||
| Collection of WordPress mu-plugins to enhance and customize a WordPress install. | ||
|
|
||
| ## Checks | ||
| ## Contributing | ||
|
|
||
| There are two checks run on pull requests: | ||
|
|
||
| 1. PHPCS | ||
| 1. PHPStan | ||
|
|
||
| PHPCS and PHPStan are managed via Composer. | ||
|
|
||
| ### Setup | ||
|
|
||
| To setup the checks locally, run the install command with the root of the WordPress install (directory with `composer.json`): | ||
|
|
||
| ``` | ||
| composer install | ||
| ``` | ||
|
|
||
| ### Run | ||
|
|
||
| #### PHPCS | ||
|
|
||
| ``` | ||
| vendor/bin/phpcs | ||
| ``` | ||
|
|
||
| #### PHPStan | ||
|
|
||
| ``` | ||
| vendor/bin/phpstan --memory-limit=-1 | ||
| ``` | ||
| Please read the [Contributing doc](contributing.md). |