add README explaining reorg of tests directory

This commit is contained in:
Lincoln Stein
2023-09-29 01:17:07 -04:00
parent 4555aec17c
commit cbf0310a2c

8
tests/README.txt Normal file
View File

@ -0,0 +1,8 @@
The nodes tests need to run before the others in order to avoid a race
condition involving fixture initialization. Please see
https://discord.com/channels/1020123559063990373/1156089584808120382/1156802853323673620
for an explanation.
For this reason, the subtests are grouped into alphabetically-ordered
folders. Do not use numeric prefixes (e.g. 00_nodes) because this
breaks python's import system.