cloudevents / cloudevents/sdk-python
Consider exposing public APIs
オープン
まだ誰も着手していません。
enhancement
- 主要言語
- Python
- スター
- 342
- フォーク
- 65
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
We should consider exposing public APIs explicitly using __init__.py. This not only makes the usage easier but also allows evolving non-public APIs without breaking outside usage and providing better backward-compatibility.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まずパッケージの init.py ファイルを特定し、SDK が現在どのように API を公開しているかを確認します。どのインターフェースを公開すべきか、また明示的なエクスポートによって後方互換性をどのように支えられるかを判断します。意図した公開 API が明確に公開され、非公開 API がサポート対象の範囲に含まれない状態になれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- api, backend
- issue の種類
- リファクタリング
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 25/100