Skip to content

Commit

Permalink
Update docs/CONTRIBUTING.md
Browse files Browse the repository at this point in the history
Co-authored-by: Jeppe Kuhlmann Andersen <78410897+jekuaitk@users.noreply.github.com>
  • Loading branch information
cableman and jekuaitk committed Oct 8, 2024
1 parent 31ddb1b commit 0ab0754
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ This document describes various tools used during development of this library.
## Install

To install the dependencies required for the development and usage of this
library, run `composer install` through the supplied Docker Compose.
library, run `composer install` through the supplied docker compose setup.

```shell
dokcer compose run --rm phpfpm composer install
docker compose run --rm phpfpm composer install
```

## Tests
Expand All @@ -18,7 +18,7 @@ We use the [PHPUnit](https://phpunit.de/) testing framework.
To run tests execute the following command:

```shell
dokcer compose run --rm phpfpm vendor/bin/phpunit --coverage-clover=coverage/unit.xml
docker compose run --rm phpfpm vendor/bin/phpunit --coverage-clover=coverage/unit.xml
```

## Check coding standards
Expand All @@ -27,20 +27,20 @@ The following commands let you test that the code follows the coding
standards we decided to adhere to in this project.

```shell
dokcer compose run --rm phpfpm composer coding-standards-check
docker compose run --rm phpfpm composer coding-standards-check
```

### Check Markdown file

```shell
dokcer compose run --rm node yarn install
dokcer compose run --rm node yarn run coding-standards-check
docker compose run --rm node yarn install
docker compose run --rm node yarn run coding-standards-check
```

## Apply coding standards

You can automatically fix some coding styles issues by running:

```shell
dokcer compose run --rm phpfpm composer coding-standards-apply
docker compose run --rm phpfpm composer coding-standards-apply
```

0 comments on commit 0ab0754

Please sign in to comment.