Add guidelines to write good conformance tests for k8s#221
Open
tonifinger wants to merge 8 commits intomainfrom
Open
Add guidelines to write good conformance tests for k8s#221tonifinger wants to merge 8 commits intomainfrom
tonifinger wants to merge 8 commits intomainfrom
Conversation
mbuechse
reviewed
Aug 16, 2024
Contributor
mbuechse
left a comment
There was a problem hiding this comment.
Thanks for drafting this! I think we should address whatever Markdownlint says. Apart from that, I would ask you to be more brief and to the point. I suggest to use simple sentences, such as "First, we check whether all requirements of the development environment are met" (instead of "this can be used to") or "Next, we start the development Kind cluster" (instead of "Once ..., you can ..."). This kind of holding-hands step-by-step guide is appropriate, but I think we should also have a brief(!) descriptive overview as well. For instance, explain the structure of the test directory, the components that are involved in testing etc.
contributor-docs/development/tests/conformance-tests-sonobuoy.md
Outdated
Show resolved
Hide resolved
contributor-docs/development/tests/conformance-tests-sonobuoy.md
Outdated
Show resolved
Hide resolved
contributor-docs/development/tests/conformance-tests-sonobuoy.md
Outdated
Show resolved
Hide resolved
1ccf535 to
a41231a
Compare
007d40e to
e5f2cb8
Compare
Signed-off-by: Toni Finger <toni.finger@cloudandheat.com>
Signed-off-by: Toni Finger <toni.finger@cloudandheat.com>
Signed-off-by: Toni Finger <toni.finger@cloudandheat.com>
Signed-off-by: Toni Finger <toni.finger@cloudandheat.com>
Signed-off-by: Toni Finger <toni.finger@cloudandheat.com>
Signed-off-by: Toni Finger <toni.finger@cloudandheat.com>
Signed-off-by: Matthias Büchse <matthias.buechse@alasca.cloud>
Signed-off-by: Matthias Büchse <matthias.buechse@alasca.cloud>
604b742 to
225fe23
Compare
This file contains hidden or 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
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.
This PR contains guidelines and best practices on how to write good conformance tests for K8S by using Sonobuoy.