Skip to content

Latest commit

 

History

History
30 lines (17 loc) · 1.09 KB

CONTRIBUTING.md

File metadata and controls

30 lines (17 loc) · 1.09 KB

Contributing

Getting Started

  1. Install asdf

  2. Install the asdf PHP plugin

asdf plugin add php https://github.com/asdf-community/asdf-php.git # Visit that repository to see installation prerequisites
  1. Run asdf install to install the version of PHP specified in the .tool-versions file
  2. Run composer install to install dependencies

Note that installing PHP via ASDF requires a number of dependencies. Instructions are in the asdf-php plugin repository. The instructions steps may fail, and are highly sensitive to your local environment. If you are having difficulty running tests or other functions, you can alternatively commit and push to a branch and let GitHub Actions run the tests & formatting for you.

Future improvements to this repository could include using Docker to encapsulate the environment and dependencies for running tests & other tools.

Running tests

./vendor/bin/phpunit

Formatting

./vendor/bin/php-cs-fixer fix

Linting

./vendor/bin/phpstan analyse