Skip to content

Commit 2842cff

Browse files
jeffreyameyerclaude
andcommitted
Refresh CONTRIBUTING testing section: vector TSVs are real now
The Testing strategy bullet list claimed loc-spec.tsv, iso8601-2.tsv, and edge-cases.tsv were planned for a future release. Those files shipped in e742539 and the test harness exercises them on every run. Update the section to reflect the actual state and to mention EdtfFormatterTest (added in 0a283cc). Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 0aea400 commit 2842cff

1 file changed

Lines changed: 11 additions & 12 deletions

File tree

CONTRIBUTING.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -117,24 +117,23 @@ Transifex rather than patching the file directly.
117117
## Testing strategy
118118

119119
- **Unit tests** per class (e.g., `EdtfDateTest`,
120-
`L0ParserTest`, `L1ParserTest`, `L2ParserTest`).
120+
`L0ParserTest`, `L1ParserTest`, `L2ParserTest`,
121+
`EdtfFormatterTest`).
121122
- **Generated parity vectors** under
122123
`src/test/resources/vectors/{level0,level1,level2}.tsv`,
123124
produced by `scripts/generate-vectors.mjs` from the upstream
124125
edtf.js. `GeneratedVectorsTest` reads them and asserts that
125126
`Edtf.parse(...)` agrees with edtf.js on type, level, min, max,
126127
and round-trip rendering.
127-
- **Planned for a future release**:
128-
- `loc-spec.tsv` &mdash; hand-curated rows from the
129-
Library of Congress EDTF spec examples.
130-
- `iso8601-2.tsv` &mdash; rows from the ISO 8601-2:2019 (and
131-
Amendment 1, 2025) clause examples.
132-
- `edge-cases.tsv` &mdash; worst-case Unicode, boundary, and
133-
deliberately-invalid inputs.
134-
135-
These three are not in the repository yet; if you write any of
136-
them, drop them in `src/test/resources/vectors/` and add a
137-
matching `@TestFactory` method in `GeneratedVectorsTest`.
128+
- **Spec vectors**: `loc-spec.tsv` (Library of Congress EDTF
129+
examples) and `iso8601-2.tsv` (ISO 8601-2:2019 standard
130+
examples) under the same path, also driven by
131+
`GeneratedVectorsTest` `@TestFactory` methods.
132+
- **Edge cases**: `edge-cases.tsv` &mdash; worst-case inputs with
133+
a 7th `valid` column. INVALID rows assert
134+
`EdtfParseException`; VALID rows round-trip. Add new
135+
pathological inputs here as you find them; the harness picks
136+
them up automatically on the next test run.
138137

139138
## Security
140139

0 commit comments

Comments
 (0)