Fehler beheben und neue Funktionen hinzufügen

Wir entwickeln Admidio mit Hilfe der Versionsverwaltung Git auf der Plattform GitHub. Der aktuelle Sourcecode befindet sich im sogenannten Master Branch und ist über folgenden Link zu finden:

https://github.com/Admidio/admidio

GitHub bietet außerdem einen Client für Mac und Windows an. Weitere Git Programme gibt es unter https://git-scm.com/.

Bevor du mit der Entwicklung neuer Funktionen anfängst, solltest du Kontakt mit uns aufnehmen bzw. Issue-Tracker nutzen um dort die gewünschte Erweiterung zu beschreiben bzw. Ideen für neue Funktionen zu sammeln.

Hast du deine Idee als Issue formuliert und mit uns abgestimmt, dann findest du im Master Branch den aktuellen Code mit allen neuen Funktionen und Änderungen, die seit dem letzten Release hinzugekommen sind. Falls du Admidio weiterentwickeln willst, empfehlen wir dir diesen Branch als Basis zu nehmen. Idealerweise erstellst du dann in deinem GitHub Account einen Fork und von diesem Branch einen Feature-Branch. Dort kannst du nun deine Erweiterung entwickeln und in den Fork commiten. Sobald deine Erweiterung fertig ist, kannst du einen Pull Request für unseren Master Branch erstellen. Diesen werden wir uns dann anschauen und besprechen um ihn dann im Idealfall zu übernehmen.

Kurz nachdem wir eine neue Hauptversion veröffentlicht haben, erstellen wir einen sogenannten Branch speziell zu dieser Version. Hier wird praktisch der aktuelle Entwicklungsstand passend zur veröffentlichten Version festgehalten. Auf diesem Entwicklungsstand können wir dann später Korrekturen einspielen unabhängig davon, was parallel im Master weiter entwickelt wurde. Der Branch ist bei uns immer passend zu einer Version. Am Namen des Branches kann man erkennen, welche Version hinter welchem Branch steckt. Beispiel für Admidio 2.4 ist der Branchname v2.4 den du unter folgender URL erreichst:

https://github.com/Admidio/admidio/tree/v2.4

Wenn ihr neu bei Admidio seit, dann solltet ihr, wie oben beschrieben, erst einmal einen Fork erstellen und neue Funktionen oder Korrekturen dort vornehmen. Diese können wir dann über einen Pull Request übernehmen. Habt ihr bereits über diese Methode Code beigetragen und entspricht dieser unseren Programmierrichtlinien, dann spricht normalerweise nichts dagegen euch auch Schreibrechte für das Admidio-Projekt in GitHub zu geben.

Möchtest du eine neue Funktion für Admidio entwickeln oder eine bestehende Funktion erweitern, dann wäre es schön, wenn du folgende Schritte durchführst.

1. Beschreibe auf unserer GitHub-Projektseite deine geplante Erweiterung. Dazu erfasst du einen neuen Issue und gibst diesem das Label Enhancement. Über diesen Issue und die dort beschriebene Funktion haben andere Teammitglieder oder Interessierte die Möglichkeit deine gewünschte Änderung kennenlernen und ggf. Anmerkungen dazu zu schreiben.
2. Möchtest du nun die Funktion programmieren, dann wechsle zum master Branch und erzeuge einen neuen Branch. Dieser bekommt als Namen das Präfix feature- und einen kurzen Funktionsnamen z.B. feature-bootstrap3-integration oder feature-improved-registration Dieser soll dann zukünftig nur deine Änderungen enthalten. Hast du noch keine Schreibrecht im Admidio-Repository dann kannst du die Funktion auch in deinem Fork entwickeln.
3. Nun kannst du deine Änderungen in diesem Feature-Branch (oder deinem eigenen Fork) entwickeln und committen, bis diese aus deiner Sicht fertig ist. Beim Einchecken (commit) sollte ein beschreibender Satz vorzugsweise in Englisch angegeben werden.
4. Erstelle nun aus deinem Feature-Branch (oder deinem eigenen Fork) einen Pull-Request. Diesen kann nun ein anderer Entwickler prüfen und mergen.

Folgende Schritte sind notwendig, wenn ihr einen Fehler beheben wollt:

1. Im ersten Schritt muss, wie bei neuen Funktionen auch, ein Issue erfasst werden, falls dieser nicht bereits schon existiert.
2. Ist der Fehler in der zuletzt veröffentlichten Version vorhanden, so sollte er dort auch korrigiert werden. Dazu wechselst du zu dem entsprechenden Branch z.B. v3.0.
3. Behebe den Fehler und führe die entsprechenden Commits in diesem Branch durch. Beim Einchecken (commit) sollte ein beschreibender Satz vorzugsweise in Englisch angegeben werden, der außerdem einen Verweis zum betreffenden Issue hat z.B. #4711 fix sql syntax when save new events
4. I.d.R. tritt der Fehler auch im master Branch auf, so dass die Commits über einen Merge in den master Branch übernommen werden müssen. Dieser Schritt kann aber auch später erfolgen.

Habt ihr noch keine Schreibrechte im Admidio-Projekt auf GitHub, so könnt ihr das Repository erst einmal forken und dort die Korrektur vornehmen. Anschließend kann die Korrektur dann über einen Pull Request in den offiziellen Code übernommen werden.