agent-substrate / agent-substrate/substrate

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

オープン
#1,185 コメント 2 件 リアクション 0 件 担当者 1 名 @HavenXia が担当を希望しています GitHub で見る
area/api area/api-machinery kind/docs
主要言語
Go
スター
1.8k
フォーク
316
平均マージ
2日 43分
マージ済み PR(30日)
287

説明

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.

コントリビューションガイド

コントリビューションガイドを開く

評価

この issue はまだ評価されていません。

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。