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.
Teilnehmen
Projektstatus
Ein Schlüssel zur Teilnahme ist es, über den aktuellen Status des Projekts informiert zu sein. Die aktuell veröffentlichte Version von SQLAlchemy befindet sich immer oben auf der Homepage auf der rechten Seite. Normalerweise gibt es zwei gleichzeitig veröffentlichte Branches, z. B. "1.3" und "1.4". Die höhere Zahl, d. h. "1.4", ist der "Default"-Branch, und "1.3" ist der "Maintenance"-Branch. Der Übergang zu einem neuen Paar von Haupt-Branches dauert etwa 12-18 Monate. Unser Ansatz, langsam und stetig vorzugehen, hat dem Projekt bisher sehr gedient und große Fortschritte in Architektur und Nutzung ermöglicht, bevor eine größere Anzahl neuer Benutzer aufgenommen wird.
Der Gesamtstatus der Entwicklung lässt sich durch einen Blick auf die GitHub-Projektseite erfassen. Wir versuchen, allen Fehlern und neuen Funktionen eine bestimmte Version zuzuweisen, die mit Meilensteinen verknüpft sind. Eine bestimmte Nummer wie "0.6.8" bedeutet, dass wir möchten, dass das Ticket bis zu dieser Version abgeschlossen ist (obwohl dies nicht immer garantiert ist). Eine "offene" Nummer wie "0.7.xx" bedeutet, dass das Ticket "in der Warteschlange" ist, aber noch keiner bestimmten Version zugeordnet ist. Viele dieser Tickets haben eine geringere Priorität, einige sind sehr aufwendig und mühsam und werden mit größeren Releases verschoben, in einigen Fällen mehrmals. Sie können mithelfen, einige davon zu bearbeiten!
GitHub
SQLAlchemy verwendet Github für die Fehlerberichterstattung und die Nachverfolgung von Problemen, für Diskussionen, Wiki-Seiten und den öffentlichen Quellcodezugriff.
Fehler melden
Fehler werden über GitHub gemeldet.
Wir bevorzugen es sehr, wenn Nutzungsprobleme zuerst als Github Discussions gemeldet werden und nicht als Issues. Sobald Probleme anhand der Problembeschreibung identifiziert sind, eröffnen SQLAlchemy-Entwickler nach Bedarf Issues zur Behebung.
Wenn Sie einen Verhaltensfehler (keinen Dokumentationsfehler) melden, bitten wir Sie:
Erstellen Sie einen prägnanten Testfall, der das Problem reproduziert. Dies muss ein Skript sein, das wir tatsächlich ausführen können – es sollte keine Importe erfordern, auf die die SQLAlchemy-Entwickler keinen Zugriff haben, und in den meisten Fällen sollten keine Importe außerhalb von SQLAlchemy selbst vorhanden sein. Es muss alle erforderlichen Tabellendefinitionen und Daten enthalten, um das Problem zu reproduzieren. Obwohl wir Zugang zu den meisten Datenbank-Backends haben, wird SQLite bevorzugt, es sei denn, das Problem ist spezifisch für ein bestimmtes Backend.
Als Leitfaden dient uns die Beschreibung Erstellen eines minimalen, vollständigen und überprüfbaren Beispiels auf StackOverflow. Bitte lesen Sie sie durch.
- Wenn Codebeispiele nicht machbar sind, geben Sie zumindest vollständige Stack-Traces für alle beobachteten Ausnahmen an. Nichts ist vager als eine Fehlermeldung ohne Stack-Trace.
- Teilen Sie uns genau mit, mit welcher Version von SQLAlchemy das Problem auftritt, sowie Details zur verwendeten Datenbank und zum genauen Treiber (z. B. Python DBAPI).
- Bitte antworten Sie auf weitere Fragen, die zu einem Issue gestellt werden. Wenn wir die benötigten zusätzlichen Informationen nicht erhalten, müssen wir den Issue in der Regel schließen.
Sicherheitslücken melden
SQLAlchemy beteiligt sich an der Tidelift-Sicherheitsinfrastruktur zur verantwortungsvollen Meldung potenzieller Schwachstellen. Bitte befolgen Sie die Richtlinien unter Tidelift Security, um ein Sicherheitsproblem zu melden. Sicherheitsprobleme in SQLAlchemy sind *extrem* selten, und es wurden in vierzehn Jahren nur drei CVEs gemeldet. Trotzdem bitten wir Sie, keine CVEs einzureichen, ohne uns vorher zu mailen, damit die entsprechenden Offenlegungsschritte unternommen werden können.
Benutzerhilfe
SQLAlchemy braucht immer Leute, die helfen, Fragen zu beantworten, insbesondere von neuen Benutzern.
Links zu aktuellen IRC / Chat-Bereichen finden Sie unter Echtzeit-Kanäle.
SQLAlchemy legt großen Wert auf höfliche, durchdachte und konstruktive Kommunikation zwischen Benutzern und Entwicklern. Unhöflichkeit, persönliche Beleidigungen oder schroffe Antworten sind niemals angemessen, auch nicht bei unangemessenen Anfragen von Benutzern. Lesen Sie unsere Verhaltensregeln für eine vollständige Erklärung. Wir versuchen auch sicherzustellen, dass keine Nachricht auf Github Discussions unbeantwortet bleibt, auch wenn die Antwort lediglich darin besteht, den Benutzer höflich auf den entsprechenden Abschnitt der Dokumentation zu verweisen. Die Kernentwickler von SQLAlchemy möchten alle Benutzer ermutigen, bei dieser Aufgabe zu helfen – wenn Sie eine sehr grundlegende Frage sehen, die seit ein paar Tagen unbeantwortet ist, hoffen wir, dass Sie darauf antworten! Sie haben unsere Erlaubnis :).
