From 97881628ebbcd14ff3ab1b3679255531449bfd68 Mon Sep 17 00:00:00 2001 From: Marien Fressinaud Date: Mon, 25 May 2020 19:06:23 +0200 Subject: tec: Add a make lint command in the Makefile (#2996) --- docs/en/developers/03_Running_tests.md | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'docs') diff --git a/docs/en/developers/03_Running_tests.md b/docs/en/developers/03_Running_tests.md index ce061cc5b..666df0412 100644 --- a/docs/en/developers/03_Running_tests.md +++ b/docs/en/developers/03_Running_tests.md @@ -18,6 +18,15 @@ Then, it executes PHPUnit in a Docker container. If you don't use Docker, you ca $ NO_DOCKER=true make test ``` +The linter can be run with a `make` command as well: + +```console +$ make lint # to execute the linter on the PHP files +$ make lint-fix # or, to fix the errors detected by the linter +``` + +Similarly to PHPUnit, it downloads a [PHP\_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) binary (i.e. `phpcs` or `phpcbf` depending on the command) and verifies its checksum. + ## Travis Tests are automatically run when you open a pull request on GitHub. It is done with [Travis CI](https://travis-ci.org/FreshRSS/FreshRSS/). This is done to ensure there is no regressions in your code. We cannot merge a PR if the tests fail so we'll ask you to fix bugs before to review your code. -- cgit v1.2.3