Skip to content

Commit

Permalink
Merge pull request #651 from phel-lang/update-contributing
Browse files Browse the repository at this point in the history
Update PHP version & add Rector to CONTRIBUTING.md
  • Loading branch information
Chemaclass committed Jan 22, 2024
2 parents c03db34 + 15bef53 commit b910337
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions .github/CONTRIBUTING.md
Expand Up @@ -68,10 +68,11 @@ $ ./vendor/bin/psalm
$ ./vendor/bin/phpstan
```

This project comes with a configuration file (located at `/.php-cs-fixer.dist.php` in the repository) that you can use to (re)format your source code for compliance with this project's coding guidelines:
This project comes with PHP CS Fixer and Rector, with which you can use to (re)format your source code for compliance with this project's coding guidelines:

```bash
$ ./vendor/bin/php-cs-fixer fix
$ ./vendor/bin/rector process
```

Please understand that we will not accept a pull request when its changes violate this project's coding guidelines.
Expand All @@ -80,7 +81,7 @@ Please understand that we will not accept a pull request when its changes violat

### Requirements

Phel requires PHP 8.0.2 or higher and Composer.
Phel requires PHP 8.2 or higher and Composer.

### Running Phel's test suites

Expand Down Expand Up @@ -121,11 +122,12 @@ composer test-compiler # test the compiler
composer test-core # test core library
> ./bin/phel test

composer test-all # clear cache, php-cs-fixer, psalm, phpstan, compiler & core tests after each other
composer test-all # clear cache, php-cs-fixer, psalm, phpstan, rector, compiler & core tests after each other
> composer static-clear-cache
> composer csrun
> composer psalm
> composer phpstan
> composer rectorrun
> composer test-compiler
> composer test-core
```
Expand Down

0 comments on commit b910337

Please sign in to comment.