From 5ca4df1585cdccd2c8af6238dda7f02a49d27767 Mon Sep 17 00:00:00 2001 From: Casper Meijn Date: Sun, 2 Jul 2023 08:55:44 +0200 Subject: [PATCH] Add test and formatter commands to CONTRIBUTING.md --- .github/CONTRIBUTING.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 33c7113cd..95eb97d61 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -45,3 +45,17 @@ Note : If you have large portions of text, use [Github's Gist service](https://g ## You want to fix a bug or to add a feature Please fork wallabag and work with **the master branch**. + +## Run Tests and PHP formatter + +All pull requests need to pass the tests and the code needs match the style guide. + +To run the tests locally run: + +- when testing using Docker: `docker-compose run --rm php make test` +- otherwise: `make test` + +To run the PHP formatter: + +- when testing using Docker: `docker-compose run --rm php bin/php-cs-fixer fix` +- otherwise: `php bin/php-cs-fixer fix`