aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorGravatar Marien Fressinaud <dev@marienfressinaud.fr> 2020-05-25 19:06:23 +0200
committerGravatar GitHub <noreply@github.com> 2020-05-25 19:06:23 +0200
commit97881628ebbcd14ff3ab1b3679255531449bfd68 (patch)
tree1882cd0f67b69cf35f46040b8465e80805b5e0f2 /docs
parent0d74cb8a4204cfaf6fd64e57b14b1ae7d23dbb84 (diff)
tec: Add a make lint command in the Makefile (#2996)
Diffstat (limited to 'docs')
-rw-r--r--docs/en/developers/03_Running_tests.md9
1 files changed, 9 insertions, 0 deletions
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.