cloudevents / cloudevents/sdk-python

Consider exposing public APIs

Offen
#176 0 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

enhancement
Vorherrschende Sprache
Python
Sterne
342
Forks
65
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

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.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit, die init.py-Dateien der Pakete zu finden und zu prüfen, wie das SDK seine APIs derzeit bereitstellt. Ermittle, welche Schnittstellen öffentlich sein sollten und wie explizite Exporte die Abwärtskompatibilität unterstützen würden. Die Aufgabe ist abgeschlossen, wenn die vorgesehenen öffentlichen APIs eindeutig bereitgestellt werden, ohne nichtöffentliche APIs zum unterstützten Umfang zu machen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
api, backend
Issue-Typ
Refactoring
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.