Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify that the test suite is not a Style Guide #324

Open
Julian opened this issue Feb 10, 2020 · 0 comments
Open

Clarify that the test suite is not a Style Guide #324

Julian opened this issue Feb 10, 2020 · 0 comments
Labels
documentation A request for new or updated documentation for the suite enhancement An enhancement to the tooling or structure of the suite (as opposed to a new test).

Comments

@Julian
Copy link
Member

Julian commented Feb 10, 2020

This seems to be a point of confusion, or even contention, so we need to document it.

The test suite is not a set of what schemas or instances one should write.

It's a verification of "specified" behavior.

We should clarify to end users that "just because you see it here, doesn't mean it's a good idea", and to implementors that "if it's here it's because that's the behavior prescribed by the spec regardless of whether it's a good idea or not to do it".

Style guides, and what users should or should not do, are separate things.

@Julian Julian added documentation A request for new or updated documentation for the suite enhancement An enhancement to the tooling or structure of the suite (as opposed to a new test). good first issue An issue that is a good candidate for new contributors labels Feb 10, 2020
@Julian Julian removed the good first issue An issue that is a good candidate for new contributors label Apr 1, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation A request for new or updated documentation for the suite enhancement An enhancement to the tooling or structure of the suite (as opposed to a new test).
Projects
None yet
Development

No branches or pull requests

1 participant