Skip to content

Consolidate versioning docs - #1288

Merged
aravindtga merged 1 commit into
kptdev:mainfrom
Nordix:consolidate-versioning-docs
Aug 7, 2026
Merged

Consolidate versioning docs#1288
aravindtga merged 1 commit into
kptdev:mainfrom
Nordix:consolidate-versioning-docs

Conversation

@aravindtga

Copy link
Copy Markdown
Contributor

Description

  • What changed: Deleted VERSIONING.md, updated the README link to point directly to the governance versioning guidelines, and moved the catalog-specific function compatibility contract into CONTRIBUTING.md
  • Why it's needed: The catalog's VERSIONING.md duplicated content now covered by the shared governance doc (kptdev/governance/VERSIONING.md). The function-specific surface contract belongs in the contributing guide where function authors will find it
  • How it works: README links to governance, CONTRIBUTING gains a "Function Compatibility" section describing user-facing surfaces and breaking change definitions

Related Issue(s)

Type of Change

  • Documentation

Checklist

  • Code follows project style guidelines
  • Self-reviewed changes
  • Tests added/updated
  • Documentation added/updated
  • All tests and gating checks pass

AI Disclosure

  • I have used AI in the creation of this PR.

If so, please describe how:
- Kiro to analyse the overlap between governance and catalog versioning docs and prepare the PR description

…atibility to CONTRIBUTING

Signed-off-by: Aravindhan Ayyanathan <aravindhan.a@est.tech>
@aravindtga aravindtga self-assigned this Aug 6, 2026
@netlify

netlify Bot commented Aug 6, 2026

Copy link
Copy Markdown

Deploy Preview for krm-function-catalog canceled.

Name Link
🔨 Latest commit 572f896
🔍 Latest deploy log https://app.netlify.com/projects/krm-function-catalog/deploys/6a749fa6696c9f00080cd25e

@aravindtga
aravindtga marked this pull request as ready for review August 6, 2026 15:00
@aravindtga
aravindtga requested review from a team August 6, 2026 15:00
@dosubot dosubot Bot added the size:L This PR changes 100-499 lines, ignoring generated files. label Aug 6, 2026
@dosubot dosubot Bot added the lgtm This PR has been approved by a maintainer label Aug 7, 2026
@aravindtga
aravindtga requested review from a team August 7, 2026 07:04
@aravindtga
aravindtga merged commit 22627e8 into kptdev:main Aug 7, 2026
14 checks passed
@aravindtga
aravindtga deleted the consolidate-versioning-docs branch August 7, 2026 08:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

lgtm This PR has been approved by a maintainer size:L This PR changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants