Add tests for canonical schemas
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 523
- Forks
- 75
- Avg merge
- 3d 16h
- Merged PRs (30d)
- 24
Description
Summary of the new feature / enhancement
As a maintainer and integrating developer, I want a functional suite of tests for the canonical DSC schemas so that I have confidence in their design and can rely on them more comfortably when working with DSC.
Proposed technical implementation details (optional)
In order of value from highest to lowest, we could:
-
Add minimal tests to ensure the bundled schemas are valid, like by using the
jvCLI tool:jv -output detailed ./schemas/2024/04/bundled/config/document.json -
Add fixtures for passing/failing objects against the schemas and verify the expected behavior, focusing on authoring mistakes that are high impact or most common.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the bundled schema at schemas/2024/04/bundled/config/document.json and use the jv CLI command shown in the issue to verify schema validity. Then review the canonical schemas and add tests or fixtures for valid and invalid objects, including high-impact authoring mistakes. Done means the bundled schemas are checked and expected pass/fail behavior is covered.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- json
- Domain
- testing
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100