Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated documentation with new tools and formatting consistency
- Loading branch information
Showing
2 changed files
with
34 additions
and
21 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 |
---|---|---|
@@ -1,21 +1,35 @@ | ||
Dev Guide | ||
========= | ||
# Dev Guide | ||
|
||
Setup | ||
----- | ||
## Setup | ||
|
||
composer install | ||
```bash | ||
composer install | ||
``` | ||
|
||
## Running tests | ||
|
||
Running tests | ||
------------- | ||
```bash | ||
vendor/bin/phpunit | ||
``` | ||
|
||
vendor/bin/phpunit | ||
## Writing Code | ||
|
||
### Checking for static analysis issues | ||
|
||
Writing Code | ||
------------ | ||
```bash | ||
vendor/bin/psalm | ||
``` | ||
|
||
We have an automated style fixer called php-cs-fixer. Style is checked on TravisCI as well. | ||
### Checking coding standards are met | ||
|
||
vendor/bin/php-cs-fixer fix | ||
```bash | ||
vendor/bin/phpcs | ||
``` | ||
|
||
### Fixing coding standards automatically | ||
|
||
We have an automated style fixer called PHP Code Sniffer. Style is checked on TravisCI as well. | ||
|
||
```bash | ||
vendor/bin/phpcbf | ||
``` |
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