Skip to content

Commit e96473d

Browse files
Alexey Inkinondrejmirtes
Alexey Inkin
authored andcommitted
Updated README
1 parent dfe3019 commit e96473d

File tree

1 file changed

+38
-8
lines changed

1 file changed

+38
-8
lines changed

README.md

Lines changed: 38 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,29 +6,59 @@
66

77
---
88

9-
This repository (`phpstan/phpstan-src`) is for PHPStan's development only. Head to [`phpstan/phpstan`](https://github.com/phpstan/phpstan) for the main README, or to [create an issue](https://github.com/phpstan/phpstan/issues/new/choose).
10-
11-
## Code of Conduct
12-
13-
This project adheres to a [Contributor Code of Conduct](https://github.com/phpstan/phpstan/blob/master/CODE_OF_CONDUCT.md).
14-
By participating in this project and its community, you are expected to uphold this code.
9+
This repository (`phpstan/phpstan-src`) is for PHPStan's development only. Head to [`phpstan/phpstan`](https://github.com/phpstan/phpstan) for the main README, or to [create an issue](https://github.com/phpstan/phpstan/issues/new/choose).
1510

1611
## Contributing
1712

1813
Any contributions are welcome.
1914

2015
### Building
2116

22-
Initially you need to run `composer install`, or `composer update` in case you aren't working in a folder which was built before.
17+
Initially you need to run `composer install`, or `composer update` in case you aren't working in a directory which was built before.
2318

2419
Afterwards you can either run the whole build including linting and coding standards using
2520

2621
```bash
2722
vendor/bin/phing
2823
```
2924

30-
or run only tests using
25+
### Running development version
26+
27+
You can also choose to run only part of the build. To analyse PHPStan by PHPStan itself, run:
28+
29+
```bash
30+
vendor/bin/phing phpstan
31+
```
32+
33+
### Fixing code style
34+
35+
To detect code style issues, run:
3136

37+
```bash
38+
vendor/bin/phing cs
39+
```
40+
41+
This requires PHP 7.4. On older versions the build target will be skipped and succeed silently.
42+
43+
And then to fix code style, run:
44+
45+
```bash
46+
vendor/bin/phing cs-fix
47+
```
48+
49+
### Running tests
50+
51+
Run:
3252
```bash
3353
vendor/bin/phing tests
3454
```
55+
56+
### Debugging
57+
58+
1. Make sure XDebug is installed and configured.
59+
2. Add `--xdebug` option when running PHPStan. Without it PHPStan turns the debugger off at runtime.
60+
61+
## Code of Conduct
62+
63+
This project adheres to a [Contributor Code of Conduct](https://github.com/phpstan/phpstan/blob/master/CODE_OF_CONDUCT.md).
64+
By participating in this project and its community, you are expected to uphold this code.

0 commit comments

Comments
 (0)