c/ooni-probe-cli
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix(CONTRIBUTING.md): mention that some tests may be flaky

Browse Source 
In particular, mention that `jafar` is painful to test under Linux. We know that
and we'll eventually also replace `jafar`. But better to tell this to newcomers
otherwise their testing experience would be not so pleasant.
This commit is contained in:
Simone Basso 2022-02-05 12:21:22 +01:00 committed by GitHub
parent d2fb7f8e6c
commit b17082b8e9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
CONTRIBUTING.md
View File

@ -71,7 +71,10 @@ and `./internal/netxlite.CopyContext` instead of `io.Copy`
## Code testing requirements
Make sure all tests pass with `go test -race ./...` run from the
top-level directory of this repository.
top-level directory of this repository. (Integration tests may be
flaky, so there may be some failures here and and there; we know
in particular that `./internal/cmd/jafar` is one of the usual
suspects and that it's not super pleasant to test it under Linux.)
## Writing a new OONI experiment