Skip to content

Commit

Permalink
Add more detail to contributing doc
Browse files Browse the repository at this point in the history
  • Loading branch information
AnesBenmerzoug committed Oct 26, 2023
1 parent 03791cc commit aa36a88
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,8 @@ There are a few important arguments:
If you experience segmentation faults with the tests,
try running them with `-n 0` to disable parallelization.

- `--slow-tests` enables running slow tests.
- `--slow-tests` enables running slow tests. See below for a description
of slow tests.

### Markers

Expand All @@ -130,7 +131,13 @@ Two important markers are:

- `pytest.mark.slow` which is used to mark slow tests and skip them by default.

You can run additionaly run slow tests using: `pytest --slow-tests`
A slow test is any test that takes 45 seconds or more to run and that can be
skipped most of the time. In some cases a test is slow, but it is required
in order to ensure that a feature works as expected and that are no bugs.
In those cases, we should not use this marker.

Slow tests are always run on CI. Locally, they are skipped
by default but can be additionally run using: `pytest --slow-tests`.

- `pytest.mark.torch` which is used to mark tests that require PyTorch.

Expand Down Expand Up @@ -346,6 +353,9 @@ runs](#skipping-ci-runs)).
pytest --splits 3 --group 2
pytest --splits 3 --group 3
```

Each one of these commands should be run in a separate shell/job
to run the test groups in parallel and decrease the total runtime.


### Running Github Actions locally
Expand Down

0 comments on commit aa36a88

Please sign in to comment.