Skip to content

Conversation

@tonifinger
Copy link
Contributor

This PR contains guidelines and best practices on how to write good conformance tests for K8S by using Sonobuoy.

@tonifinger tonifinger linked an issue Aug 14, 2024 that may be closed by this pull request
@tonifinger tonifinger self-assigned this Aug 14, 2024
@tonifinger tonifinger requested a review from mbuechse August 14, 2024 08:22
Copy link
Contributor

@mbuechse mbuechse left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@tonifinger tonifinger force-pushed the 201-add-guidelines-to-write-good-conformance-tests-for-k8s branch from 1ccf535 to a41231a Compare October 1, 2024 07:46
@mbuechse mbuechse force-pushed the 201-add-guidelines-to-write-good-conformance-tests-for-k8s branch 2 times, most recently from 007d40e to e5f2cb8 Compare November 28, 2025 11:27
@mbuechse mbuechse marked this pull request as ready for review November 28, 2025 12:45
@mbuechse mbuechse force-pushed the 201-add-guidelines-to-write-good-conformance-tests-for-k8s branch from 604b742 to 225fe23 Compare November 28, 2025 12:45
@mbuechse mbuechse self-requested a review November 28, 2025 12:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add guidelines to write good conformance tests for K8S

3 participants