Skip to content

Commit dc65951

Browse files
committed
added documentation about folder in root readme and folder readme
1 parent c4a99e0 commit dc65951

File tree

2 files changed

+14
-6
lines changed

2 files changed

+14
-6
lines changed

README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -79,15 +79,13 @@ Here is a single *test case*, containing one or more tests:
7979

8080
### Subdirectories Within Each Version directory
8181

82-
There is currently only one additional subdirectory that may exist within each specification version test directory.
82+
A specification version test directory may contain one or more subdirectories.
8383

84-
This is:
84+
These are:
8585

86-
1. `optional/`: Contains tests that are considered optional.
86+
1. `optional/`: Contains tests that are considered optional. Note that this subdirectory currently conflates many reasons why a test may be optional -- it may be because tests within a particular file are indeed not required by the specification but still potentially useful to an implementer, or it may be because tests within it only apply to programming languages with particular functionality (in which case they are not truly optional in such a language). In the future this directory structure will be made richer to reflect these differences more clearly.
8787

88-
Note, the `optional/` subdirectory today conflates many reasons why a test may be optional -- it may be because tests within a particular file are indeed not required by the specification but still potentially useful to an implementer, or it may be because tests within it only apply to programming languages with particular functionality (in
89-
which case they are not truly optional in such a language).
90-
In the future this directory structure will be made richer to reflect these differences more clearly.
88+
2. `proposals/`: Contains a subfolder for each active proposal to the specification. If the proposal is a keyword (generally the case), then the subfolder will bear the name of that keyword. Inside the proposal subfolder is a series of test files that would contain amendments to the required test suite should the proposal be incorporated into the specification. These test should be considered volitile while the proposal is in development, however implementations claiming to support the proposal are expected to pass its tests.
9189

9290
## Using the Suite to Test a Validator Implementation
9391

tests/v1/proposals/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# JSON Schema Proposals Tests
2+
3+
The subfolders herein represent tests for each active proposal to the specification. If the proposal is a keyword (generally the case), then the subfolder will bear the name of that keyword. Inside the proposal subfolder is a series of test files that would contain amendments to the required test suite should the proposal be incorporated into the specification. These test should be considered volitile while the proposal is in development, however implementations claiming to support the proposal are expected to pass its tests.
4+
5+
> [!IMPORTANT]
6+
> This folder is NOT intended for proposed additions to the test suite or the specification.
7+
8+
Proposals to the test suite can be made by [opening an issue](https://github.com/json-schema-org/JSON-Schema-Test-Suite/issues/new) in this repository.
9+
10+
Proposals to the specification should be made by following the process defined by our [Feature Life Cycle](https://github.com/json-schema-org/json-schema-spec/blob/main/PROCESS.md#feature-life-cycle).

0 commit comments

Comments
 (0)