Skip to content

docs: explain protocol vs capability versioning#418

Open
ptiper wants to merge 1 commit intoUniversal-Commerce-Protocol:mainfrom
ptiper:docs/update-versioning-docs
Open

docs: explain protocol vs capability versioning#418
ptiper wants to merge 1 commit intoUniversal-Commerce-Protocol:mainfrom
ptiper:docs/update-versioning-docs

Conversation

@ptiper
Copy link
Copy Markdown
Contributor

@ptiper ptiper commented May 7, 2026 •
edited
Loading

Description

  • Update versioning.md with high-level two-tiered versioning concepts.
  • Link to detailed specifications in overview.md to avoid duplication.
  • Add protocol compatibility alert and negotiation links in overview.md.
  • Fix markdown formatting to pass lint checks.

Category (Required)

  • Core Protocol: Changes to the base communication layer, global context, or breaking refactors. (Requires Technical Council approval)
  • Governance/Contributing: Updates to GOVERNANCE.md, CONTRIBUTING.md, or CODEOWNERS. (Requires Governance Council approval)
  • Capability: New schemas (Discovery, Cart, etc.) or extensions. (Requires Maintainer approval)
  • Documentation: Updates to README, or documentations regarding schema or capabilities. (Requires Maintainer approval)
  • Infrastructure: CI/CD, Linters, or build scripts. (Requires DevOps Maintainer approval)
  • Maintenance: Version bumps, lockfile updates, or minor bug fixes. (Requires DevOps Maintainer approval)
  • SDK: Language-specific SDK updates and releases. (Requires DevOps Maintainer approval)
  • Samples / Conformance: Maintaining samples and the conformance suite. (Requires Maintainer approval)
  • UCP Schema: Changes to the ucp-schema tool (resolver, linter, validator). (Requires Maintainer approval)
  • Community Health (.github): Updates to templates, workflows, or org-level configs. (Requires DevOps Maintainer approval)

Checklist

  • I have followed the Contributing Guide.
  • I have updated the documentation (if applicable).
  • My changes pass all local linting and formatting checks.
  • (For Core/Capability) I have included/updated the relevant JSON schemas.
  • I have regenerated Python Pydantic models by running generate_models.sh under python_sdk.

Screenshots / Logs (if applicable)

Screenshot 2026-05-07 at 10 13 31 image

@ptiper ptiper requested review from a team as code owners May 7, 2026 08:13
@ptiper ptiper requested review from jingyli, knightlin-shopify, pemamian, westeezy and wry-ry and removed request for knightlin-shopify, pemamian and westeezy May 7, 2026 08:13
@ptiper
docs: explain protocol vs capability versioning
b720e36 
- Update versioning.md with high-level two-tiered versioning concepts.

- Link to detailed specifications in overview.md to avoid duplication.

- Add protocol compatibility alert and negotiation links in overview.md.

- Fix markdown formatting to pass lint checks.
@ptiper ptiper force-pushed the docs/update-versioning-docs branch from 4073c07 to b720e36 Compare May 7, 2026 08:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@wry-ry wry-ry Awaiting requested review from wry-ry wry-ry is a code owner automatically assigned from Universal-Commerce-Protocol/devops-maintainers

@jingyli jingyli Awaiting requested review from jingyli

At least 2 approving reviews are required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@ptiper