Skip to content

Commit d6fe1d4

Browse files
authored
Contributing: add notes for how to checkout the files
Quick note on how best to install the dependencies so that `commit check` is ready to go.
1 parent 6060fe5 commit d6fe1d4

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

.github/CONTRIBUTING.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,34 @@ Sniff name starts with | Report to
2929

3030
----
3131

32+
## Getting the source files
33+
34+
```sh
35+
git clone [email protected]:Automattic/VIP-Coding-Standards.git vipcs
36+
```
37+
38+
...or:
39+
40+
```sh
41+
gh repo clone Automattic/VIP-Coding-Standards vipcs
42+
```
43+
44+
Now `cd vipcs` and run:
45+
46+
```sh
47+
composer install --ignore-platform-req=php+
48+
```
49+
50+
The platform requirements for higher versions of PHP are ignored so that the correct version of PHPUnit (7.x needed by PHPCS) is installed.
51+
52+
You can now run:
53+
54+
```
55+
composer check
56+
```
57+
58+
... and all checks should pass.
59+
3260
## tl;dr Composer Scripts
3361

3462
This package contains Composer scripts to quickly run the developer checks which are described (with setups) further below.

0 commit comments

Comments
 (0)