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

Deprecate MatrixHttpApi methods related to msgtype and move to Room

Ouverte
#190 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Api layer architecture breaking enhancement good first issue
Langage dominant
Python
Étoiles
266
Forks
118
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

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.

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par localiser MatrixHttpApi et la Room API, puis identifiez les méthodes liées à msgtype que cet issue prévoit de déprécier. Examinez comment ces méthodes correspondent aux endpoints et déterminez un emplacement cohérent pour le comportement. Le travail est considéré comme terminé lorsque l’API suit le principe « une méthode par endpoint » et que la fonctionnalité concernée a été déplacée vers Room lorsque cela est approprié.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
api, backend-api-design
Type d'issue
Refactorisation
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
30/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.