Skip to content

Commit

Permalink
Document the tooling used in this project
Browse files Browse the repository at this point in the history
  • Loading branch information
sebastianbergmann committed Mar 25, 2023
1 parent 1b7162f commit f67155e
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions README.md
Expand Up @@ -112,3 +112,33 @@ array(3) {
This is a low maintenance project. The scope of features and support are purposefully kept narrow for my purposes to ensure long term maintenance is viable. I am not looking to grow this into a bigger project at all.

Issues and PRs raised for bugs are perfectly fine assuming they do not significantly increase the scope of the project. Please do not open PRs for new features that expand the scope.

## Development

This project uses [PHPUnit](https://phpunit.de/) and [Infection](https://infection.github.io/) for testing:

```shell
./tools/phpunit
```

```shell
./tools/infection
```

This project uses [Psalm](https://psalm.dev/) for type checking:

```shell
./tools/psalm --config=.psalm/config.xml
```

This project uses [PHP-CS-Fixer](https://cs.symfony.com/) to enforce coding guidelines:

```shell
./tools/php-cs-fixer fix
```

The commands shown above require an autoloader script at `vendor/autoload.php`. This can be generated like so:

```shell
./tools/composer dump-autoload
```

0 comments on commit f67155e

Please sign in to comment.