Skip to content

Commit cf84a17

Browse files
committed
some improvements to tests/best-practices.md
1 parent 96a3dec commit cf84a17

1 file changed

Lines changed: 4 additions & 5 deletions

File tree

src/tests/best-practices.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -91,9 +91,8 @@ of making the test possible to be filtered via `--test-args` as a collection of
9191
9292
To help other contributors understand what the test is about if their changes
9393
lead to the test failing, we should make sure a test has sufficient docs about
94-
its intent/purpose, links to relevant context (incl.
95-
issue numbers or other
96-
discussions) and possibly relevant resources (e.g. can be helpful to link to
94+
its intent/purpose, links to relevant context (including issue numbers or other discussions)
95+
and possibly relevant resources (e.g. it can be helpful to link to
9796
Win32 APIs for specific behavior).
9897
9998
**Synopsis of a test with good comments**
@@ -146,7 +145,7 @@ This may include remarks on:
146145
separate because...).
147146
- Platform-specific behaviors.
148147
- Behavior of external dependencies and APIs: syscalls, linkers, tools,
149-
environments and the likes.
148+
environments and the like.
150149

151150
## Test content
152151

@@ -167,7 +166,7 @@ place.
167166
contributors and waste their time trying to figure out if test failure is related.
168167
- Flaky tests provide no useful information from its test results other than
169168
it's flaky and not reliable: if a test passed but it's flakey, did I just get lucky?
170-
if a test is flakey but it failed, was it just spurious?
169+
If a test is flakey but it failed, was it just spurious?
171170
- Flaky tests degrade confidence in the whole test suite.
172171
If a test suite can
173172
randomly spuriously fail due to flaky tests, did the whole test suite pass or

0 commit comments

Comments
 (0)