luciano/d2
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

add line about test cases

Browse source
This commit is contained in:
Júlio César Batista 2022-12-30 14:33:40 -03:00
parent cb414e5382
commit 9aca3e2c0b
No known key found for this signature in database
GPG key ID: 10C4B861BF314878
1 changed files with 6 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
docs/CONTRIBUTING.md
View file

@ -54,7 +54,7 @@ start work on an Issue, please leave a comment so others know that it's being wo
### Tests ### Tests
All code changes must include tests. D2 mostly has functional tests, and uses All code changes must include tests. D2 mostly has functional tests (see `e2etests` directory), and uses
[diff](https://github.com/terrastruct/diff) as a framework that gives Git-style [diff](https://github.com/terrastruct/diff) as a framework that gives Git-style
comparisons of expected vs actual output for each stage. There are ample examples in each comparisons of expected vs actual output for each stage. There are ample examples in each
package of this -- try changing some test and run it to see. package of this -- try changing some test and run it to see.
@ -82,6 +82,11 @@ Run: `./ci/test.sh`
CI runs tests with `-race` to catch potential race conditions. It's much slower, but if CI runs tests with `-race` to catch potential race conditions. It's much slower, but if
your machine can run it locally, you can do so with `./make.sh race`. your machine can run it locally, you can do so with `./make.sh race`.
If you had to change/add functional test cases (under `e2etests` directory), make sure
you updated them before opening a PR.
Run: `TESTDATA_ACCEPT=1 ./ci/test.sh` or `TA=1 ./ci/test.sh` for a shorter version.
#### Chaos tests #### Chaos tests
D2 has [chaos tests](https://en.wikipedia.org/wiki/Chaos_engineering) which produce random D2 has [chaos tests](https://en.wikipedia.org/wiki/Chaos_engineering) which produce random