mirrors/dendrite
1
0
Fork 0
mirror of https://github.com/matrix-org/dendrite.git synced 2025-12-16 03:13:11 -06:00
Code Issues Packages Projects Releases Wiki Activity

Apply suggestions to sytest.md from code review

Browse source 
Co-Authored-By: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
This commit is contained in:
Alex Chen 2019-06-21 22:29:53 +08:00 committed by GitHub
parent 39110cd254
commit 0ea26a72aa
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
docs/sytest.md
View file

@ -9,8 +9,8 @@ tracked through the amount of SyTest tests it passes.
## Finding out which tests to add ## Finding out which tests to add
We recommend you run the tests locally by manually setting up sytest or using a We recommend you run the tests locally by manually setting up SyTest or using a
sytest docker image. After running the tests, a script will print the tests you SyTest docker image. After running the tests, a script will print the tests you
need to add to `testfile` for you. need to add to `testfile` for you.
You should proceed after you see no build problems for dendrite after running: You should proceed after you see no build problems for dendrite after running:
@ -19,11 +19,11 @@ You should proceed after you see no build problems for dendrite after running:
./build.sh ./build.sh
``` ```
### Manually Setting up sytest ### Manually Setting up SyTest
Make sure you have Perl v5+ installed, and get sytest with: Make sure you have Perl v5+ installed, and get SyTest with:
(Note that this guide assumes your `sytest` checkout is next to your (Note that this guide assumes your SyTest checkout is next to your
`dendrite` checkout.) `dendrite` checkout.)
```sh ```sh
@ -64,9 +64,9 @@ any newly passing test names to `testfile` in the project's root directory:
If the script prints nothing/exits with 0, then you're good to go. If the script prints nothing/exits with 0, then you're good to go.
### Using a sytest Docker image ### Using a SyTest Docker image
Ensure you have the latest image for sytest, then run the tests: Ensure you have the latest image for SyTest, then run the tests:
```sh ```sh
docker pull matrixdotorg/sytest-dendrite docker pull matrixdotorg/sytest-dendrite