-
Notifications
You must be signed in to change notification settings - Fork 8
Add guidelines to write good conformance tests for k8s #221
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
base: main
Are you sure you want to change the base?
Add guidelines to write good conformance tests for k8s #221
Conversation
mbuechse
left a comment
There was a problem hiding this 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.
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 <[email protected]>
Signed-off-by: Toni Finger <[email protected]>
Signed-off-by: Toni Finger <[email protected]>
Signed-off-by: Toni Finger <[email protected]>
Signed-off-by: Toni Finger <[email protected]>
Signed-off-by: Toni Finger <[email protected]>
Signed-off-by: Matthias Büchse <[email protected]>
Signed-off-by: Matthias Büchse <[email protected]>
604b742 to
225fe23
Compare
This PR contains guidelines and best practices on how to write good conformance tests for K8S by using Sonobuoy.