json-schema-org / json-schema-org/JSON-Schema-Test-Suite

The suite should explicitly document its backwards compatibility policy

Open
#223 3 comments 1 reaction 1 assignee View on GitHub

@Relequestual is already working on this.

Since Nov 22, 2019.

documentation enhancement
Dominant language
Python
Stars
750
Forks
307
Avg merge
3d 17h
Merged PRs (30d)
24

Description

This suite is generally not versioned (despite such things having been requested in the past).

Regardless though, it is important to define exactly what sorts of backwards compatibility we offer. E.g. -- do we guarantee that files will stay in the same location? That tests will not change descriptions? That the directory structure won't change?

Some of these things have changed recently, so to help those who use the suite, we should explicitly note which of the above (and others) we guarantee.

Possibly here we should also therefore change the structure of the repo into one that clearly delineates between an authoring format and an output format -- e.g., from an authoring standpoint, it's potentially annoying to have to replicate tests across drafts, so perhaps tests should by default be replicated, unless explicitly restricted. But from an output standpoint, it's likely more convenient to fully denormalize the output, so that users of the suite can treat each version completely independently.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.