Zum Inhalt springen

Hilfe SQLModel - Hilfe erhalten

Mögen Sie SQLModel?

Möchten Sie SQLModel, anderen Benutzern und dem Autor helfen?

Oder möchten Sie Hilfe mit SQLModel erhalten?

Es gibt sehr einfache Möglichkeiten zu helfen (mehrere erfordern nur einen oder zwei Klicks).

Und es gibt auch mehrere Möglichkeiten, Hilfe zu erhalten.

Abonnieren Sie den FastAPI and Friends Newsletter

Sie können den (seltenen) Newsletter FastAPI and Friends abonnieren, um auf dem Laufenden zu bleiben über

  • Nachrichten über FastAPI und Freunde, einschließlich SQLModel 🚀
  • Anleitungen 📝
  • Funktionen ✨
  • Bruchänderungen 🚨
  • Tipps und Tricks ✅

Geben Sie SQLModel einen Stern auf GitHub

Sie können SQLModel auf GitHub "mit einem Stern versehen" (klicken Sie auf den Stern-Button oben rechts): https://github.com/fastapi/sqlmodel. ⭐️

Indem Sie einen Stern vergeben, können andere Benutzer es leichter finden und sehen, dass es für andere bereits nützlich war.

Beobachten Sie das GitHub-Repository für Veröffentlichungen

Sie können SQLModel auf GitHub "beobachten" (klicken Sie auf den "Watch"-Button oben rechts): https://github.com/fastapi/sqlmodel. 👀

Dort können Sie "Nur Veröffentlichungen" auswählen.

Dadurch erhalten Sie Benachrichtigungen (in Ihrer E-Mail), wenn es eine neue Veröffentlichung (eine neue Version) von SQLModel mit Fehlerbehebungen und neuen Funktionen gibt.

Vernetzen Sie sich mit dem Autor

Sie können sich mit mir (Sebastián Ramírez / tiangolo), dem Autor, vernetzen.

Sie können

  • Folgen Sie mir auf GitHub.
    • Sehen Sie andere Open-Source-Projekte, die ich erstellt habe und die Ihnen helfen könnten.
    • Folgen Sie mir, um zu sehen, wann ich ein neues Open-Source-Projekt erstelle.
  • Folgen Sie mir auf Twitter.
    • Erzählen Sie mir, wie Sie SQLModel verwenden (ich höre das gerne).
    • Erfahren Sie, wann ich Ankündigungen mache oder neue Tools veröffentliche.
  • Vernetzen Sie sich mit mir auf LinkedIn.
    • Erfahren Sie, wann ich Ankündigungen mache oder neue Tools veröffentliche (obwohl ich Twitter häufiger nutze 🤷‍♂).
  • Lesen Sie, was ich schreibe (oder folgen Sie mir) auf Dev.to oder Medium.
    • Lesen Sie andere Ideen, Artikel und erfahren Sie von Tools, die ich erstellt habe.
    • Folgen Sie mir, um zu lesen, wenn ich etwas Neues veröffentliche.

Twittern Sie über SQLModel

Twittern Sie über SQLModel und lassen Sie mich und andere wissen, warum Sie es mögen. 🎉

Ich höre gerne davon, wie SQLModel verwendet wird, was Ihnen daran gefallen hat, in welchem Projekt/Unternehmen Sie es verwenden usw.

Helfen Sie anderen bei Fragen auf GitHub

Sie können versuchen, anderen bei ihren Fragen zu helfen in

In vielen Fällen kennen Sie die Antwort auf diese Fragen vielleicht bereits. 🤓

Denken Sie einfach daran, der wichtigste Punkt ist: Versuchen Sie, freundlich zu sein. Menschen kommen mit ihren Frustrationen und fragen oft nicht auf die beste Weise, aber versuchen Sie Ihr Bestes, um freundlich zu sein. 🤗

Die Idee ist, dass die SQLModel-Community freundlich und einladend ist. Gleichzeitig dürfen Sie Mobbing oder respektloses Verhalten gegenüber anderen nicht tolerieren. Wir müssen aufeinander aufpassen.


So helfen Sie anderen bei Fragen (in Diskussionen oder Issues)

Verstehen Sie die Frage

  • Prüfen Sie, ob Sie den Zweck und den Anwendungsfall der fragenden Person verstehen können.

  • Prüfen Sie dann, ob die Frage (die überwiegende Mehrheit sind Fragen) klar ist.

  • In vielen Fällen dreht sich die gestellte Frage um eine imaginäre Lösung des Benutzers, aber es könnte eine bessere geben. Wenn Sie das Problem und den Anwendungsfall besser verstehen, können Sie möglicherweise eine bessere alternative Lösung vorschlagen.

  • Wenn Sie die Frage nicht verstehen können, bitten Sie um weitere Details.

Reproduzieren Sie das Problem

In den meisten Fällen und bei den meisten Fragen gibt es etwas, das mit dem Originalcode der Person zu tun hat.

In vielen Fällen kopieren sie nur ein Fragment des Codes, aber das reicht nicht aus, um das Problem zu reproduzieren.

  • Sie können sie bitten, ein minimal, reproduzierbares Beispiel bereitzustellen, das Sie kopieren und einfügen und lokal ausführen können, um denselben Fehler oder dasselbe Verhalten zu sehen, das sie sehen, oder um ihren Anwendungsfall besser zu verstehen.

  • Wenn Sie sich sehr großzügig fühlen, können Sie versuchen, ein Beispiel wie dieses selbst zu erstellen, nur basierend auf der Beschreibung des Problems. Bedenken Sie jedoch, dass dies viel Zeit in Anspruch nehmen kann und es besser sein könnte, sie zunächst um Klärung des Problems zu bitten.

Schlagen Sie Lösungen vor

  • Nachdem Sie die Frage verstehen konnten, können Sie ihnen eine mögliche Antwort geben.

  • In vielen Fällen ist es besser, ihr zugrundeliegendes Problem oder ihren Anwendungsfall zu verstehen, da es möglicherweise eine bessere Möglichkeit gibt, es zu lösen, als das, was sie versuchen zu tun.

Bitten Sie um Schließung

Wenn sie antworten, besteht eine hohe Wahrscheinlichkeit, dass Sie ihr Problem gelöst haben, herzlichen Glückwunsch, Sie sind ein Held! 🦸

  • Nun, wenn das ihr Problem gelöst hat, können Sie sie bitten:

    • In GitHub-Diskussionen: Markieren Sie den Kommentar als Antwort.
    • In GitHub-Issues: Schließen Sie das Issue.

Beobachten Sie das GitHub-Repository

Sie können SQLModel auf GitHub "beobachten" (klicken Sie auf den "Watch"-Button oben rechts): https://github.com/fastapi/sqlmodel. 👀

Wenn Sie "Watching" statt "Nur Veröffentlichungen" auswählen, erhalten Sie Benachrichtigungen, wenn jemand ein neues Issue oder eine neue Frage erstellt. Sie können auch angeben, dass Sie nur über neue Issues, Diskussionen oder PRs usw. benachrichtigt werden möchten.

Dann können Sie versuchen, ihnen zu helfen, diese Fragen zu lösen.

Fragen Sie nach

Sie können eine neue Frage im GitHub-Repository erstellen, zum Beispiel um

  • Eine Frage stellen oder nach einem Problem fragen.
  • Einen neuen Feature-Vorschlag machen.

Hinweis: Wenn Sie das tun, werde ich Sie auch bitten, anderen zu helfen. 😉

Überprüfen Sie Pull Requests

Sie können mir helfen, Pull Requests von anderen zu überprüfen.

Auch hier gilt: Versuchen Sie Ihr Bestes, freundlich zu sein. 🤗


Hier ist, was Sie beachten sollten und wie Sie einen Pull Request überprüfen

Verstehen Sie das Problem

  • Stellen Sie zunächst sicher, dass Sie das Problem verstehen, das der Pull Request zu lösen versucht. Möglicherweise gibt es eine längere Diskussion in einer GitHub-Diskussion oder einem Issue.

  • Es besteht auch eine gute Chance, dass der Pull Request eigentlich nicht benötigt wird, weil das Problem auf eine andere Weise gelöst werden kann. Dann können Sie dies vorschlagen oder danach fragen.

Machen Sie sich keine Sorgen um den Stil

  • Machen Sie sich keine zu großen Sorgen um Dinge wie Commit-Nachrichtenstile, ich werde sie zusammenfassen und den Commit manuell anpassen.

  • Machen Sie sich auch keine Sorgen um Stilregeln, dafür gibt es bereits automatisierte Tools.

Und wenn es andere Stil- oder Konsistenzanforderungen gibt, werde ich direkt danach fragen oder Commits darüber mit den benötigten Änderungen hinzufügen.

Überprüfen Sie den Code

  • Lesen Sie den Code, sehen Sie, ob er Sinn ergibt, führen Sie ihn lokal aus und sehen Sie, ob er das Problem tatsächlich löst.

  • Dann kommentieren Sie, dass Sie dies getan haben, so weiß ich, dass Sie ihn wirklich überprüft haben.

Info

Leider kann ich PRs, die nur mehrere Genehmigungen haben, nicht einfach vertrauen.

Mehrfach ist es passiert, dass PRs mit 3, 5 oder mehr Genehmigungen vorhanden waren, wahrscheinlich weil die Beschreibung ansprechend ist, aber wenn ich die PRs überprüfe, sind sie tatsächlich kaputt, haben einen Fehler oder lösen das Problem nicht, das sie zu lösen behaupten. 😅

Daher ist es wirklich wichtig, dass Sie den Code tatsächlich lesen und ausführen und mich in den Kommentaren wissen lassen, dass Sie dies getan haben. 🤓

  • Wenn der PR auf eine Weise vereinfacht werden kann, können Sie danach fragen, aber es muss nicht zu wählerisch sein, es kann viele subjektive Standpunkte geben (und ich werde auch meinen eigenen haben 🙈), daher ist es besser, wenn Sie sich auf die grundlegenden Dinge konzentrieren können.

Tests

  • Helfen Sie mir zu überprüfen, ob der PR Tests hat.

  • Prüfen Sie, ob die Tests vor dem PR fehlschlagen. 🚨

  • Prüfen Sie dann, ob die Tests nach dem PR bestehen. ✅

  • Viele PRs haben keine Tests, Sie können sie daran erinnern, Tests hinzuzufügen, oder Sie können sogar selbst einige Tests vorschlagen. Das ist eines der Dinge, die am meisten Zeit in Anspruch nehmen, und Sie können dabei sehr helfen.

  • Kommentieren Sie dann auch, was Sie versucht haben, damit ich weiß, dass Sie es überprüft haben. 🤓

Erstellen Sie einen Pull Request

Sie können zum Quellcode beitragen mit Pull Requests, zum Beispiel

  • Um einen Tippfehler zu beheben, den Sie in der Dokumentation gefunden haben.
  • Um neue Dokumentationsabschnitte vorzuschlagen.
  • Um ein bestehendes Problem/einen Fehler zu beheben.
    • Stellen Sie sicher, dass Sie Tests hinzufügen.
  • Um eine neue Funktion hinzuzufügen.
    • Stellen Sie sicher, dass Sie Tests hinzufügen.
    • Stellen Sie sicher, dass Sie Dokumentation hinzufügen, wenn diese relevant ist.

Helfen Sie bei der Wartung von SQLModel

Helfen Sie mir bei der Wartung von SQLModel! 🤓

Es gibt viel zu tun, und das meiste davon können SIE tun.

Die Hauptaufgaben, die Sie im Moment erledigen können, sind

Diese beiden Aufgaben verbrauchen am meisten Zeit. Das ist die Hauptarbeit bei der Wartung von SQLModel.

Wenn Sie mir dabei helfen können, helfen Sie mir bei der Wartung von SQLModel und sorgen Sie dafür, dass es schneller und besser vorankommt. 🚀

Treten Sie dem Chat bei

Treten Sie dem 👥 FastAPI und Freunde Discord Chat-Server 👥 bei und hängen Sie mit anderen in der Community ab. Es gibt einen #sqlmodel Kanal.

Tipp

Für Fragen stellen Sie diese in GitHub-Diskussionen, dort ist die Wahrscheinlichkeit, Hilfe zu bekommen, viel höher.

Nutzen Sie den Chat nur für andere allgemeine Gespräche.

Nutzen Sie den Chat nicht für Fragen

Beachten Sie, dass Chats, da sie mehr "freie Konversation" ermöglichen, leicht zu allgemein gestellte und schwerer zu beantwortende Fragen zulassen, sodass Sie möglicherweise keine Antworten erhalten.

Auf GitHub führt die Vorlage Sie dazu, die richtige Frage zu formulieren, damit Sie leichter eine gute Antwort erhalten oder das Problem sogar selbst lösen können, bevor Sie fragen. Und auf GitHub kann ich sicherstellen, dass ich immer alles beantworte, auch wenn es einige Zeit dauert. Persönlich kann ich das mit dem Chat nicht tun. 😅

Gespräche im Chat sind auch nicht so leicht durchsuchbar wie auf GitHub, so dass Fragen und Antworten in der Konversation verloren gehen können.

Auf der anderen Seite gibt es Tausende von Benutzern im Chat, so dass die Wahrscheinlichkeit hoch ist, dass Sie jemanden zum Reden finden, fast die ganze Zeit. 😄

Sie können den Autor (mich) auch finanziell durch GitHub-Sponsoren unterstützen.

Dort könnten Sie mir einen Kaffee ☕️ kaufen, um Danke zu sagen. 😄

Wie Sie in der Dokumentation gesehen haben, steht SQLModel auf den Schultern von Giganten: Pydantic und SQLAlchemy.

Sie können auch sponsern


Danke! 🚀