CONTRIBUTING

MITARBEIT AN GRATHEON

Vielen Dank für Ihr Interesse, zu Gratheon beizutragen! Wir begrüßen Beiträge aus der Community.

Mitwirkenden-Lizenzvereinbarung (CLA)

Bevor wir Ihre Beiträge annehmen können, benötigen wir, dass Sie unsere Mitwirkenden-Lizenzvereinbarung (CLA) unterschreiben. Dies ist eine Standardpraxis für Open-Source-Projekte und hilft uns, klare Eigentums- und Lizenzierungsrechte am Code zu gewährleisten.

Warum brauchen wir eine CLA?

Gratheon verwendet ein Modell der doppelten Lizenzierung:

  • AGPL v3 für Open-Source-Nutzung
  • Kommerzielle Lizenz für Enterprise-Kunden

Die CLA gibt uns die Rechte:

  1. Ihren Beitrag sowohl in der Open-Source-Version als auch in der kommerziellen Version einzuschließen
  2. Ihren Beitrag unter verschiedenen Bedingungen neu zu lizenzieren, falls erforderlich
  3. Das Projekt vor rechtlichen Problemen zu schützen

Wichtig: Sie behalten das Eigentum an Ihrem Beitrag und können ihn weiterhin nach Belieben nutzen. Die CLA gibt uns lediglich die Erlaubnis, ihn ebenfalls zu verwenden.

So unterschreiben Sie die CLA

Wir verwenden CLA Assistant, um den CLA-Prozess zu optimieren:

  1. Erstmals beitragende Personen: Wenn Sie Ihren ersten Pull Request einreichen, wird der CLA Assistant Bot automatisch einen Kommentar abgeben und Sie auffordern, die CLA zu unterschreiben.

  2. Klicken Sie auf den Link im Kommentar des Bots, um die CLA einzusehen und zu unterschreiben.

  3. Unterschreiben Sie digital mit Ihrem GitHub-Konto (dauert ca. 2 Minuten).

  4. Fertig! Sobald Sie unterzeichnet haben, können Sie zu jedem Gratheon-Repository beitragen.

Alternativ können Sie:

Für Unternehmensbeiträge

Wenn Sie im Rahmen Ihrer Arbeit beitragen, muss Ihr Arbeitgeber das Unternehmens-CLA unterschreiben. Bitte lassen Sie Ihre Rechtsabteilung das Unternehmens-CLA prüfen und unterschreiben.

Verhaltenskodex

Seien Sie respektvoll und konstruktiv in allen Interaktionen. Wir folgen den Standardrichtlinien der Open-Source-Community.

Wie man beiträgt

Probleme melden

  • Überprüfen Sie, ob das Problem bereits existiert
  • Verwenden Sie Issue-Vorlagen, falls verfügbar
  • Geben Sie klare Schritte zur Reproduktion an
  • Fügen Sie relevante Umgebungsdetails hinzu

Pull Requests einreichen

  1. Fork das Repository
  2. Erstellen Sie einen Branch für Ihre Funktion/Fix
  3. Nehmen Sie Ihre Änderungen vor unter Einhaltung unserer Codestandards:
    • Sauberer, lesbarer Code
    • Keine unnötigen Kommentare (Code sollte selbsterklärend sein)
    • Bestehenden Code-Stil befolgen
    • Tests hinzufügen, falls anwendbar
  4. Testen Sie Ihre Änderungen gründlich
  5. Reichen Sie einen Pull Request ein mit:
    • Klare Beschreibung der Änderungen
    • Link zum related Issue, falls zutreffend
    • Screenshots/Beispiele, falls relevant

Codestandards

  • Schreiben Sie sauberen, wartbaren Code
  • Folgen Sie den bestehenden Mustern im Codebase
  • Keine TODO-Kommentare (erstellen Sie stattdessen Issues)
  • Für Go: Fügen Sie t.Parallel() zu unabhängigen Tests hinzu
  • Für Go: Verwenden Sie // ARRANGE // ACT // ASSERT in Tests
  • Verwenden Sie menschenlesbare Testnamen

Entwicklungsumgebung

Siehe die README.md in jedem Repository für spezifische Setup-Anweisungen.

Fragen?

  • Erstellen Sie ein Issue für Bugs oder Feature-Anfragen
  • Senden Sie eine E-Mail an pilot@gratheon.com für CLA- oder kommerzielle Lizenzierungsfragen

Lizenz

Indem Sie zu Gratheon beitragen, stimmen Sie zu, dass Ihre Beiträge unter derselben doppelten Lizenzstruktur lizenziert werden:

  • AGPL v3 für Open-Source-Nutzung
  • Für die kommerzielle Lizenzierung für Enterprise-Kunden verfügbar

Siehe LICENSE-AGPL und LICENSE-COMMERCIAL Dateien für Details.


Vielen Dank, dass Sie zu Gratheon beitragen! 🐝