Marking public APIs with `@Public` annotation
メンテナーはふだん 1 日以内に返信
評価
この issue はまだ評価されていません。
説明
In order to better communicate - in terms of semver - which our APIs are considered public we should introduce @Public annotation, and mark appropriate classes / methods etc. Note this is source level compatibility, not binary.
Note that there are libraries that provide such annotations like:
org.apiguardian:apiguardian-api:
@API(status = Status.STABLE)
@API(status = Status.EXPERIMENTAL)
@API(status = Status.INTERNAL)
@API(status = Status.MAINTAINED)
@API(status = Status.DEPRECATED)
For reference, Flink's own @Public/@PublicEvolving/@Experimental/@Internal in org.apache.flink.annotation are the same idea, but they're internal to Flink (and shaded), so not meant to be pulled in as a standalone dependency.
Notes
- we have already
@Experimentalannotation. - this could be done an an inverse way, so marking internal API, butin our case would be probably harder to do (or more code)
- 主要言語
- Java
- スター
- 944
- フォーク
- 242
- 平均マージ
- 1日 14時間
- マージ済み PR（30日）
- 46
環境構築
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
operator-framework/java-operator-sdk のほかの issue
-
Method Reconciler#reconcile is not triggered when resource is deleted.対応中かも @xstefank が 6 日前に担当しました。 オープン
難易度 4/5 3〜5日 初心者へのやさしさ 55/100
operator-framework/java-operator-sdk#3621 · コメント 8 件 · 担当者 1 名 ·
メンテナーはふだん 1 日以内に返信
-
難易度 4/5 3〜5日 初心者へのやさしさ 38/100
operator-framework/java-operator-sdk#3615 · コメント 1 件 · リアクション 3 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 4/5 3〜5日 初心者へのやさしさ 45/100
operator-framework/java-operator-sdk#3568 · コメント 1 件 · リアクション 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
operator-framework/java-operator-sdk#3563 ·
メンテナーはふだん 1 日以内に返信
-
Support for Virtual Threads対応中かも @xstefank が 46 日前に担当しました。 オープン
operator-framework/java-operator-sdk#3538 · コメント 2 件 · 担当者 2 名 ·
メンテナーはふだん 1 日以内に返信
operator-framework/java-operator-sdk の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
OpenAPITools/openapi-generator#25014 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 92/100
AloisSeckar/demos-java#380 ·
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
openhab/openhab-core#5847 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
appsmithorg/appsmith#42297 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100