Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[DOCS] Rework the development deps section in CONTRIBUTING.md #1354

Merged
merged 2 commits into from
Oct 27, 2024
Merged

[DOCS] Rework the development deps section in CONTRIBUTING.md #1354

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6b96b78
[DOCS] Rework the development deps section in `CONTRIBUTING.md`
oliverklee Oct 27, 2024
ed09931
Update CONTRIBUTING.md
oliverklee Oct 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 13 additions & 8 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,18 +53,23 @@ first before investing a lot of time in writing code.

## Install the development dependencies

To install the development dependencies (PHPUnit and PHP_CodeSniffer), please
run the following commands:
To install the most important development dependencies, please run the following
command:

```shell
```bash
composer install
composer require --dev slevomat/coding-standard:^4.0
```

Note that the development dependencies (in particular, for PHP_CodeSniffer)
require PHP 7.0 or later. The second command installs the PHP_CodeSniffer
dependencies and should be omitted if specifically testing against an earlier
version of PHP, however you will not be able to run the static code analysis.
We also have some optional development dependencies that require higher PHP
versions than the lowest PHP version this project supports. Hence they are not
installed by default.

To install these, you will need to have [PHIVE](https://phar.io/) installed.
You can then run the following command:

```bash
phive install
```

## Unit-test your changes

Expand Down