agent-substrate / agent-substrate/substrate

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

Ouverte
#1,185 2 commentaires 0 réactions 1 personne assignée Réclamée par @HavenXia Voir sur GitHub
area/api area/api-machinery kind/docs
Langage dominant
Go
Étoiles
1.8k
Forks
316
Merge moyen
2 j 43 min
PR mergées (30 j)
287

Description

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.

Guide de contribution

Ouvrir le guide de contribution

Évaluation

Cette issue n'a pas encore été évaluée.

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.