matrix-org / matrix-org/matrix-python-sdk

Deprecate MatrixHttpApi methods related to msgtype and move to Room

オープン
#190 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

Api layer architecture breaking enhancement good first issue
主要言語
Python
スター
266
フォーク
118
PR マージ指標
30日以内にマージされた PR はありません

説明

To make the sdk api consistent, the general principle for the sdk should be that there's one method per endpoint in MatrixHttpApi. We can at most have a method for each type (m.room.message, etc.), but whatever we do we need to be consistent, and having a method per msgtype very much isn't.

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

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

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

まず MatrixHttpApi と Room API の場所を確認し、次にこの issue で非推奨にする対象となっている msgtype 関連のメソッドを特定します。これらのメソッドがエンドポイントにどのように対応しているかを確認し、その動作を一貫して配置する場所を決定します。API が 1 エンドポイント 1 メソッドの原則に従い、影響を受ける機能が適切に Room へ移されていれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
python
領域
api, backend-api-design
issue の種類
リファクタリング
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
30/100

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

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