docs(developer/contribute): add Sphinx anchors

This commit is contained in:
jon r 2025-02-22 23:57:32 +01:00
parent 106f332144
commit e6b246379e
3 changed files with 42 additions and 0 deletions

View File

@ -129,8 +129,13 @@ def test_downgrade_not_superuser_skips_email(factories, mocker):
mocked_notify.assert_not_called() mocked_notify.assert_not_called()
``` ```
<!-- prettier-ignore-start -->
(runtests)=
## Run tests ## Run tests
<!-- prettier-ignore-end -->
You can run all tests in the pytest suite with the following command: You can run all tests in the pytest suite with the following command:
```sh ```sh

View File

@ -59,8 +59,13 @@ yarn dev:docs
- Find more details about the UI library and [how to contributein the live docs](http://localhost:5173/contributing) - Find more details about the UI library and [how to contributein the live docs](http://localhost:5173/contributing)
<!-- prettier-ignore-start -->
(testing)=
## Testing ## Testing
<!-- prettier-ignore-end -->
### Unit tests ### Unit tests
The Funkwhale frontend contains some tests to catch errors before changes go live. The coverage is still fairly low, so we welcome any contributions. The Funkwhale frontend contains some tests to catch errors before changes go live. The coverage is still fairly low, so we welcome any contributions.

View File

@ -424,3 +424,35 @@ Fallback ports are available for the documentation at
Maintain their life cycle with similar commands to those used to Maintain their life cycle with similar commands to those used to
[set up auxiliary services (point 2.)](#set-up-auxiliary-services). [set up auxiliary services (point 2.)](#set-up-auxiliary-services).
## Running the test suites
Run the App test suite:
```sh
docker compose run --rm front yarn test
```
Run the App tests with coverage:
```sh
docker compose run --rm front yarn test:unit
```
<!-- prettier-ignore -->
Please also see the [Testing](<#testing>) in the App contributing guidelines.
Run the API test suite:
```sh
docker compose run --rm api pytest
```
Run a single test:
```sh
docker compose run --rm api pytest tests/music/test_models.py
```
<!-- prettier-ignore -->
Please also see [Run tests](<#runtests>) in the API contributing guidelines.