Comments (1)
I agree, Testnames, Description part the comment section should be iterated properly. To the best of my knowledge I have added description and tried grouping tests using test name prefixes, etc.
I do understand that a carefully crafted Describe+Context+It blocks should make a human readable string that the the tool can use in place for Description. But having a Description field in the comment section will allow you to describe the test in detail with additional information nicely formatted as bullet points, etc.
When promoting a test to conformance, the idea is to then to say to the customer everything he needs to know about the test through the description field (instead for going back and changing top down all the wording from the Describe block onwards).
BTW: if there is no description field, the tool will just pick up text from Describe, Context and It blocks. (see v1.11 document in the end for tests that do not have documentation)
Release tag is introduced recently for the same reason, a non technical user need not have to go through and find when the source is changed but instead can rely on the tag to figure out when the test is added followed by release numbers when changes to the test happened.
from k8s-conformance.
Related Issues (20)
- e2e tests are failing HOT 1
- Conformance Test: some [sig-network] tests failed. HOT 4
- Attempt to run sonobuoy on K8s cluster failed at pull images for the container.
- README.md : Fix spelling and grammar HOT 2
- conformance v1.18.7 & v1.18.8 fails with Pod entered a fatal terminal status: failed HOT 1
- Missing conformance docs for 1.16-1.21
- Update verify-conformance-tests to have better xml parsing HOT 6
- Our installer product doesn't have a website yet HOT 2
- After conformance certification, service not displayed in 'Certified Kubernetes - Hosted '. HOT 2
- Kubernetes Conformance - Expired Certification HOT 3
- [cncf-ci checks failed] The acutal conformance test has passed. HOT 1
- Windows Operational Readiness formatting HOT 2
- Branch protection rules HOT 5
- Missing conformance docs for 1.22-1.25
- Add contact email as requiement for PRODUCT.yaml with Conformance submissions HOT 3
- GHA to Automate the generation of the Conformance Document HOT 1
- Scrape commit email addresses for CNCF/K8s-Conformance for Conformance submissions for release 1.23-1.25 HOT 2
- Roll out Prow Github actions on cncf/k8s-conformance for test in of /assign of multi github handles HOT 5
- Update reviewing.md HOT 5
- doc for extend conformance time period
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from k8s-conformance.