agent-substrate / agent-substrate/substrate

[Upgrade] Add an api_changes.md: rules for changing protos and CRDs

Offen
#1,185 2 Kommentare 0 Reaktionen 1 zugewiesene Person Beansprucht von @HavenXia Auf GitHub ansehen
area/api area/api-machinery kind/docs
Vorherrschende Sprache
Go
Sterne
1.8k
Forks
316
Ø Merge
2 T. 43 Min.
Gemergte PRs (30 T.)
287

Beschreibung

As discussed across recent upgrade discussions and issues (e.g. [upgrade proposal](https://docs.google.com/document/d/1JduAyGZFyqdNp4UhKiv0EN-is3iW5tf5BwGTWbt2ouI/edit?usp=sharing&resourcekey=0-MXG12QCkleIxhY7cOB7g6A), #954), we currently lack unified guidelines for **evolving** our APIs, Protobuf schemas, and CRDs.

Without a standard document, questions frequently arise regarding:
- How server should handle unknown or unrecognized fields across version upgrades.
- Expectations and review criteria for developers introducing behavioral or schema changes.

I think we should create an `api-changes.md` like kubernetes to talk about API compatibility and provide clear guidance for contributor.

Beitragsleitfaden

Beitragsleitfaden öffnen

Bewertung

Dieses Issue wurde noch nicht bewertet.

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.