Skip to content

docs: add conformance fixture contribution guidance#1958

Open
kmishra1204 wants to merge 2 commits into
a2aproject:mainfrom
kmishra1204:docs/conformance-fixture-guidance
Open

docs: add conformance fixture contribution guidance#1958
kmishra1204 wants to merge 2 commits into
a2aproject:mainfrom
kmishra1204:docs/conformance-fixture-guidance

Conversation

@kmishra1204

@kmishra1204 kmishra1204 commented Jun 19, 2026

Copy link
Copy Markdown

Summary

  • add a dedicated section in CONTRIBUTING for conformance fixture proposals
  • define minimum metadata to improve cross-SDK interoperability validation

Context

Closes #1957.

Notes

Docs-only change.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request updates CONTRIBUTING.md to add a new section outlining recommended patterns and minimum metadata for conformance fixture contributions. The feedback suggests capitalizing the first letter of each bullet point in the new section to maintain consistency with other lists in the repository.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread CONTRIBUTING.md Outdated
Comment on lines +120 to +123
- protocol area covered (for example: discovery, lifecycle, errors, streaming)
- expected request/response shape or event sequence
- pass/fail criteria that can be checked across SDKs
- edge case rationale (why this fixture matters for interoperability)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

low

For consistency with other lists in the repository (such as those in README.md), the bullet points should start with a capital letter.

Suggested change
- protocol area covered (for example: discovery, lifecycle, errors, streaming)
- expected request/response shape or event sequence
- pass/fail criteria that can be checked across SDKs
- edge case rationale (why this fixture matters for interoperability)
- Protocol area covered (for example: discovery, lifecycle, errors, streaming)
- Expected request/response shape or event sequence
- Pass/fail criteria that can be checked across SDKs
- Edge case rationale (why this fixture matters for interoperability)

@kmishra1204 kmishra1204 changed the title Docs: add conformance fixture contribution guidance docs: add conformance fixture contribution guidance Jun 29, 2026
@kmishra1204

Copy link
Copy Markdown
Author

Thanks for the pipeline checks. I just updated this PR metadata to satisfy repo gates:

  • title normalized to conventional commit style (docs:)
  • PR description updated with an explicit linked issue (Closes #1957)

Validate PR Title and Check linked issues are now passing.

I still see Check Spelling failing due the workflow action security advisory (not due changed docs text). Happy to re-run once the workflow is updated, or apply any maintainer-preferred workaround.

@kmishra1204 kmishra1204 force-pushed the docs/conformance-fixture-guidance branch from eef08f7 to 0feecca Compare June 29, 2026 20:05
@kmishra1204 kmishra1204 force-pushed the docs/conformance-fixture-guidance branch from 0feecca to 509e9f2 Compare July 4, 2026 08:42
@kmishra1204

Copy link
Copy Markdown
Author

Applied the review wording fix in faec896.

What changed:

  • Capitalized the first word in each new conformance fixture metadata bullet for consistency with the surrounding contribution guide style.

Local validation:

  • npx --yes markdownlint-cli --config .github/linters/.markdownlint.json CONTRIBUTING.md
  • git diff --check

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.

[Feat]: Add protocol conformance fixtures for cross-implementation interoperability

1 participant