Organisation des Sphinx-Projekts

Der Leitfaden erklärt, wie das Sphinx-Projekt organisiert ist.

Kernentwickler

Die Kernentwickler von Sphinx haben Schreibzugriff auf das Hauptrepository. Sie können Änderungen committen, Pull-Requests akzeptieren/ablehnen und Elemente im Issue Tracker verwalten.

Richtlinien

Die folgenden allgemeinen Richtlinien gelten für Kernentwickler:

  • Fragwürdige oder umfangreiche Änderungen sollten als Pull-Request eingereicht werden, anstatt direkt in das Hauptrepository committet zu werden. Der Pull-Request sollte von einem anderen Kernentwickler überprüft werden, bevor er gemergt wird.

  • Trivial-Änderungen können direkt committet werden, aber stellen Sie sicher, dass das Repository in einem guten Arbeitszustand ist und alle Tests bestanden werden, bevor Sie Ihre Änderungen pushen.

  • Beim Committen von Code, der von jemand anderem geschrieben wurde, bitte weisen Sie den ursprünglichen Autor in der Commit-Nachricht und in jedem relevanten CHANGES.rst Eintrag zu.

Mitgliedschaft

Die Kernmitgliedschaft basiert auf kontinuierlichen aktiven Beiträgen zum Projekt. Im Allgemeinen sollten potenzielle Kernmitglieder Folgendes nachweisen:

  • ein gutes Verständnis für eine oder mehrere Komponenten von Sphinx

  • eine Geschichte hilfreicher, konstruktiver Beiträge

  • die Bereitschaft, Zeit in die Verbesserung von Sphinx zu investieren

Weitere Informationen finden Sie unter Beitrag zu Sphinx.

Andere Mitwirkende

Sie müssen kein Kernentwickler sein oder Schreibzugriff haben, um an der Entwicklung von Sphinx beteiligt zu sein. Sie können Patches einreichen oder Pull-Requests von geforkten Repositories erstellen und einen Kernentwickler die Änderungen für Sie hinzufügen lassen.

Ebenso sind Beiträge nicht auf Code-Patches beschränkt. Wir freuen uns auch über Hilfe bei der Triage von Fehlern, Input zu Designentscheidungen, Überprüfungen bestehender Patches und Verbesserungen der Dokumentation. Weitere Informationen finden Sie unter Beitrag zu Sphinx.

Eine Liste der Personen, die zu Sphinx beigetragen haben, finden Sie unter Sphinx-Autoren.