Revise some of the docs, add information about upgrading #876
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Josh Humphries <2035234+jhump@users.noreply.github.com>
jhump
changed the title
Signed-off-by: Josh Humphries <2035234+jhump@users.noreply.github.com>
|
ping @smaye81 |
smaye81
approved these changes
May 28, 2024
| 1. Update to the new release of the conformance suite. | ||
| 2. Update test case patterns (like in known-failing configurations) if necessary to match | ||
| any changes to test case names and organization. | ||
| 3. Update/add known-failing configurations for any new failures resulting from new/updated |
There was a problem hiding this comment.
This is one case where automatically appending tests to a known-failing file would be super helpful.
Signed-off-by: Josh Humphries <2035234+jhump@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I was reviewing some of the docs and noticed a few things that could be improved.
The changes to the Status: Stable section of the README stem from thinking about other kinds of changes that we must reasonably make from time to time that could prevent a user from easily being able to upgrade to a newer version of the suite. I figured being very explicit about this in this document is best for clarity and transparency.
This also adds a section to the README that describes the machinery of the thing and also includes a sequence diagram to show what's going on inside the test runner.