Skip to content

Commit ac63eb7

Browse files
committed
Small README update that introduces the concept of directories
1 parent 697944e commit ac63eb7

File tree

1 file changed

+16
-8
lines changed

1 file changed

+16
-8
lines changed

README.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,16 @@ choice is still the job of the validator implementor.
1212
Structure of a Test
1313
-------------------
1414

15-
The tests in this suite are contained in the `tests` directory at the
16-
root of this repository.
15+
The tests in this suite are contained in the `tests` directory at the root of
16+
this repository. Inside that directory is a subdirectory for each draft or
17+
version of the specification.
1718

18-
Inside that directory is a subdirectory for each draft or version of the
19-
specification.
19+
Inside each draft directory, there are a number of `.json` files and one or more
20+
special subdirectories. The subdirectories contain `.json` files meant for a
21+
specific testing purpose, and each `.json` file logically groups a set of test
22+
cases together. Often the grouping is by property under test, but not always.
2023

21-
Inside each draft directory, there are a number of `.json` files, which
22-
logically group a set of test cases together. Often the grouping is by
23-
property under test, but not always, especially within optional test
24-
files (discussed below).
24+
The subdirectories are described in the next section.
2525

2626
Inside each `.json` file is a single array containing objects. It's easiest to
2727
illustrate the structure of these with an example:
@@ -50,6 +50,14 @@ test in the `tests` array is an objects with a description of the case
5050
itself, the instance under test, and a boolean indicating whether it
5151
should be valid or invalid.
5252

53+
Test Subdirectories
54+
-------------------
55+
56+
There is currently only one subdirectory that may exist within each draft
57+
directory. This is:
58+
59+
1. `optional/`: Contains tests that are considered optional.
60+
5361
Coverage
5462
--------
5563

0 commit comments

Comments
 (0)