Skip to content

docs(conformance): drop playbook mention from adding-a-test section - #5247

Draft
elezar wants to merge 1 commit into
test/3954-testkit-test-program/matthewgrossmanfrom
docs/conformance-readme-wording/elezar
Draft

elezar wants to merge 1 commit into
test/3954-testkit-test-program/matthewgrossmanfrom
docs/conformance-readme-wording/elezar

Conversation

@elezar

@elezar elezar commented Nov 4, 2026

Copy link
Copy Markdown
Member

Summary

Trims the "Adding a test" section of the conformance README so it no longer mentions playbooks, test archives or workflow entries. Playbooks are separate from the tests themselves. Addresses review feedback on #5138.

Related Issue

None. This is a wording fix on the parent PR branch, which targets test/3954-testkit-test-program/matthewgrossman.

Changes

  • Remove the playbook, test archive and workflow entry sentence from tests/suites/conformance/README.md.
  • Keep the guidance to add a #[testkit::test] function, or a new file in src/ plus a mod line in src/lib.rs.

Testing

  • Checks appropriate to the affected code and behavior pass (docs-only change)
  • Unit tests added/updated (if applicable)
  • E2E tests added/updated (if applicable)

Checklist

  • Follows Conventional Commits
  • Commits are signed off (DCO)
  • Architecture docs updated (if applicable)

Signed-off-by: Evan Lezar <elezar@nvidia.com>
@elezar elezar added area:build Related to CI/CD and builds topic:testing labels Nov 4, 2026
@elezar
elezar marked this pull request as draft November 4, 2026 13:52
@copy-pr-bot

copy-pr-bot Bot commented Nov 4, 2026

Copy link
Copy Markdown

Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually.

Contributors can view more details about this message here.

@matthewgrossman

Copy link
Copy Markdown
Member

#5249 already includes this wording (its tests/suites/conformance/README.md is identical to this branch's), and this PR targets #5138's branch, which I'll close once #5249 merges. I think this can be closed in favour of #5249.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:build Related to CI/CD and builds topic:testing

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants