aboutsummaryrefslogtreecommitdiff
path: root/docs/en/developers/03_Running_tests.md
diff options
context:
space:
mode:
authorGravatar Alexandre Alapetite <alexandre@alapetite.fr> 2021-03-15 00:00:25 +0100
committerGravatar Alexandre Alapetite <alexandre@alapetite.fr> 2021-03-15 00:00:25 +0100
commit1c3159058fd256ec7163a29c9865dbd3dbe05f17 (patch)
tree5b3a9df3cc709a4b370f6f03cf79c50483275344 /docs/en/developers/03_Running_tests.md
parent769f34e958b50e748acf6a151805f4a255df2043 (diff)
Quick update the doc for master renaming to edge
Diffstat (limited to 'docs/en/developers/03_Running_tests.md')
-rw-r--r--docs/en/developers/03_Running_tests.md18
1 files changed, 9 insertions, 9 deletions
diff --git a/docs/en/developers/03_Running_tests.md b/docs/en/developers/03_Running_tests.md
index 666df0412..24d80fe9a 100644
--- a/docs/en/developers/03_Running_tests.md
+++ b/docs/en/developers/03_Running_tests.md
@@ -1,28 +1,28 @@
# Running tests
-FreshRSS is tested with [PHPUnit](https://phpunit.de/). No code should be merged in `master` if the tests don't pass.
+FreshRSS is tested with [PHPUnit](https://phpunit.de/). No code should be merged in `edge` if the tests don’t pass.
## Locally
As a developer, you can run the test suite on your PC easily with `make` commands. You can run the test suite with:
-```console
-$ make test
+```sh
+make test
```
This command downloads the PHPUnit binary and verifies its checksum. If the verification fails, the file is deleted. In this case, you should [open an issue on GitHub](https://github.com/FreshRSS/FreshRSS/issues/new) to let maintainers know about the problem.
Then, it executes PHPUnit in a Docker container. If you don't use Docker, you can run the command directly with:
-```console
-$ NO_DOCKER=true make test
+```sh
+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
+```sh
+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.
@@ -31,4 +31,4 @@ Similarly to PHPUnit, it downloads a [PHP\_CodeSniffer](https://github.com/squiz
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.
-If you're interested in, you can take a look at [the configuration file](https://github.com/FreshRSS/FreshRSS/blob/master/.travis.yml).
+If you're interested in, you can take a look at [the configuration file](https://github.com/FreshRSS/FreshRSS/blob/edge/.travis.yml).