Community Guide
Ein Leitfaden zur Beteiligung an SQLAlchemy und den zugehörigen Projekten.
Auch wenn diese Abschnitte möglicherweise für Entwickler des Kernprojekts SQLAlchemy geschrieben wurden, gelten die verschiedenen Richtlinien, insbesondere der Verhaltenskodex, für alle Projekte, die im Repository der SQLAlchemy-Organisation gehostet werden.
Unterstützung erhalten
Bevor Sie Support anfordern, nutzen Sie bitte die verfügbaren Online-Ressourcen, wo die Antworten auf eine große Anzahl von Fragen bereits zu finden sind. Das wichtigste davon sind die Dokumentation. Viele Fragen, die in SQLAlchemy-Foren gestellt werden, werden durch einfache Suchen mit der Suchleiste oben rechts auf der Indexseite oder in der linken Spalte jeder Dokumentationsseite beantwortet. Die Dokumentation wird ständig bearbeitet und verbessert, manchmal dramatisch. Probleme mit der Dokumentation können als Fehler gemeldet werden (siehe Fehler melden). Ein anderer Ansatz ist die Suche im Github Discussions Forum, das schnell zu einer primären Informationsressource wird.
Github Diskussionen
SQLAlchemy und seine zugehörigen Projekte bieten nun Support über den Link Github Discussions auf der Github-Seite jedes Projekts an. Diese Forum-ähnliche Schnittstelle ermöglicht Diskussionen, die eher denen einer Mailingliste ähneln, aber mit besserer Unterstützung für die Darstellung von Codebeispielen und die Verknüpfung mit Problemen. Wenn Sie im Diskussionsforum posten, bitten wir die Poster, nach bestem Wissen und Gewissen Nachrichten zu verfassen, die sowohl in ihrer Beschreibung vollständig als auch prägnant in Bezug auf das Thema sind.
- Vollständig - Wichtige Details wie die verwendete SQLAlchemy-Version, die Art der verwendeten Datenbank (MySQL 8, PostgreSQL 12 usw.) sowie vollständige Stack-Traces für Fehlermeldungen werden bereitgestellt, ebenso wie klare Code-Abschnitte, die die genaue Verwendung veranschaulichen, die zu dem Symptom führt.
- Prägnant - Code und Ausgabe werden gekürzt und formatiert, um nur das vorliegende Problem zu veranschaulichen - Details, die für das vorliegende Problem nicht direkt relevant sind, sollten so weit wie möglich gekürzt werden, einschließlich nicht relevanter Tabellen und Modelle, Abhängigkeiten von internen oder externen Bibliotheken, nicht relevanter Objektmethoden und Beziehungen, großer Mengen von Spaltendefinitionen, die weggelassen werden können, komplizierter interner Variablennamen, die für Außenstehende schwer zu lesen sind.
Dies sind nur Richtlinien, da wir Benutzer aller Fähigkeitsstufen aufnehmen können und dies regelmäßig tun. Solange Sie sich bemühen, das Problem zu recherchieren und sorgfältig zu beschreiben, haben Sie sich unseren Support verdient!
Echtzeit-Kanäle: Gitter, IRC
Es gibt mehrere Echtzeit-Optionen für den Support.
Die Entwickler von SQLAlchemy bitten alle Teilnehmer dieser Kanäle, den Verhaltenskodex zu respektieren, wenn sie Unterstützung suchen oder geben.
Kernentwickler sind manchmal in diesen Kanälen anwesend, aber bitte heben Sie sie nicht für individuelle Hilfe hervor! Es gibt normalerweise etwa 80-100 Mitglieder gleichzeitig - viele davon können wahrscheinlich bei Ihrem Problem helfen. Wenn Ihr Problem wirklich komplizierter ist und mehr fähige Hilfe erfordert, als derzeit auf IRC oder Gitter verfügbar ist, dann ist es an der Zeit, im Github Discussions Forum zu posten.
Gitter-Raum
Der sqlalchemy/community Gitter-Raum steht für Echtzeit-Support zur Verfügung. Es sind normalerweise eine Handvoll SQLAlchemy-Benutzer und Entwickler anwesend und bereit zu helfen.
Im Gegensatz zu IRC bietet Gitter eine durchsuchbare öffentliche Historie - Benutzer müssen sich also nicht ständig anmelden und können alle Gespräche überprüfen, die sie verpasst haben.
IRC-Kanal
Eine beliebte Support-Ressource ist der IRC-Kanal. In diesem Forum können Benutzer aller Fähigkeitsstufen kurze Fragen stellen, Code-Schnipsel posten und Techniken mit anderen anwesenden Entwicklern diskutieren. Die üblichen Regeln der IRC-Etikette gelten hier. Benutzer, die sich im Voraus bemüht haben, ihr Problem zu verstehen, werden tendenziell bessere Ergebnisse erzielen.
Der IRC-Kanal ist im Libera Netzwerk unter dem Namen #sqlalchemy.
Professioneller Support mit Tidelift
Professioneller Support für SQLAlchemy ist als Teil des Tidelift Subscription verfügbar. Tidelift bietet Softwareentwicklungsteams eine einzige Quelle für den Kauf und die Wartung ihrer Software, mit professionellen Zusicherungen von den Experten, die sie am besten kennen, und integriert sich nahtlos in bestehende Werkzeuge.