Zusammenarbeit

Mitarbeit an REDAXO

REDAXO bietet als quelloffenes System viele Möglichkeiten der Mitarbeit. Eine Mitarbeit kostet natürlich Zeit, bietet aber auch viele persönliche Vorteile: Das System und die Dokumentation wird nicht nur immer besser, sondern man lernt auch eine ganze Menge dabei.

Slack-Channel

Erster Anlaufpunkt ist in jedem Fall der FOR Slack Channel, in dem sich Entwickler und Anwender austauschen. Für den Slack-Channel gibt es eine direkte Anmeldemöglichkeit beim Slack-Anmeldeformular.

Forum

Das Forum ist ebenso eine Möglichkeit, sich auszutauschen, Fragen zu stellen oder anderen Anwendern zu helfen.

Referenzen

Mit REDAXO erstellte Seiten können im Bereich Referenzen eingestellt werden.

Friends of Redaxo (FOR)

Friends of Redaxo ist eine Initiative von und für Entwickler, die eine offenere Zusammenarbeit anstreben. AddOns in diesem Bereich können grundsätzlich von jedem anderen FOR-Mitglied bearbeitet werden. FOR-Code wird immer unter der MIT-Lizenz veröffentlicht. Dennoch bleibt der Ersteller hauptverantwortlich für das AddOn, sofern er seine Verantwortlichkeit nicht abgeben möchte. Somit kann ein AddOn auch weiter entwickelt werden, selbst wenn der Hauptentwickler das AddOn nicht mehr weiter entwickelt. AddOns, die im FOR-Bereich veröffentlicht werden, kann man als vollständige Spende eines Entwicklers an die Community betrachten.

Dokumentation

Mitarbeit im Bereich Dokumentation ist ausdrücklich erwünscht. Auch hier gibt es viele verschiedene Möglichkeiten. Wer etwas findet, was in der Dokumentation fehlt oder ungenau beschrieben ist, darf gerne Ergänzungen beitragen, zum Beispiel im Github-Repository der Doku.

Fehler gefunden?

Bei Fehlern ist zunächst zu prüfen, ob es sich um Implementierungsfehler oder Fehler im Code handelt. In jedem Falle ist eine möglichst aussagekräftige Beschreibung des Fehlers für den Entwickler hilfreich, um das Phänomen nachzustellen und darauf zu reagieren. In eine Fehlerbeschreibung gehören immer folgende Angaben:

  • Welche Bedienungsschritte führen zu dem Fehler?
  • Unter welcher Umgebung (PHP Version, Webserver, Provider, lokales System) tritt der Fehler auf?
  • Unter welchem Browser und in welcher Version des Browsers tritt der Fehler auf?
  • Was wurde zuletzt am System verändert (z.B. Installation von AddOns)?
  • Wie macht sich der Fehler bemerkbar?

Die Fehlerbeschreibung kann um Errorlog-Meldungen ergänzt werden.

Git Issues

Der Core von REDAXO und die meisten AddOns werden als Git-Repositories gepflegt. Dort lassen sich Fehler oder Wünsche in "Issues" eintragen. Bevor ein Issue eingetragen wird, empfiehlt sich folgendes Vorgehen: Zunächst prüft man, ob man die aktuellste Version des AddOns aus dem Git-Repository im Einsatz hat. Anschließend prüft man, ob das Issue bereits eingetragen oder bearbeitet wurde. Eine kurze Nachfrage im Slack-Channel, ob das gewünschte Feature oder der gefundene Fehler sinnvoll als Issue erfasst werden sollte, kann die Recherche ergänzen. Anschließend erstellt man im entsprechenden Repository das Issue.

Pull Requests

Bei konkreten Codevorschlägen empfehlen sich "Pull Requests". Der Entwickler hat dann die Möglichkeit den Code zu prüfen und direkt zu übernehmen.

Eigene AddOns

Ein eigenes AddOn zu entwickeln ist immer eine Möglichkeit, sich aktiv an der Entwicklung zu beteiligen. Ist das AddOn für eine größere Anzahl von Anwendern von Interesse, kann dieses in den Downloadbereich eingestellt werden.

Redaxo Entwickler

Im Loginbereich von REDAXO kann man sich selbst als Redaxo-Entwickler eintragen und wird dann auf der REDAXO-Website als Entwickler gelistet.