agent-substrate / agent-substrate/substrate

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

Aberta
#1,185 2 comentários 0 reações 1 responsável Reivindicada por @HavenXia Ver no GitHub
area/api area/api-machinery kind/docs
Linguagem predominante
Go
Estrelas
1.8k
Forks
316
Merge médio
2d 43min
PRs com merge (30d)
287

Descrição

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.

Guia de contribuição

Abrir o guia de contribuição

Avaliação

Esta issue ainda não foi avaliada.

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.