Sourcecodeverwaltung

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.

Der Master Branch beinhaltet den Code der letzten stabilen Version und zusätzlich alle stabilen Erweiterungen, 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 von diesem Branch in deinem GitHub Account einen Fork. 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.

Habt ihr Schreibrechte und wollt eine neue Funktion zu Admidio hinzufügen, dann sollte dies erst einmal in einem separaten Entwicklungsbranch geschehen. Dazu könnt ihr einfach über die Gui einen neuen Brach mit dem Präfix feature- und einem Funktionsnamen eurer Erweiterung anlegen.

feature-bootstrap3-integration
feature-improved-registration

In diesem Branch kann die neue Funktion dann fertig entwickelt und auch von anderen getestet oder begutachtet werden. Außerdem hat dies den Vorteil, dass der Master Branch immer relativ stabil ist und dort nur fertige neue Funktionen commited werden.

Beim Einchecken (commit) sollte ein beschreibeneder Satz vorzugsweise in Englisch angegeben werden, der außerdem einen Verweis zum betreffenden Issue hat.

#4711 Add new button to registration formular
#342  Change check of date fields

Wird ein Fehler in der aktuellen veröffentlichten Version gefunden, so sollte im ersten Schritt ein Issue erfasst werden. Im nächsten Schritt müsst ihr schauen, in welchem Versionsbranch z.B. v2.4 der Fehler enthalten ist und ob der Fehler auch im aktuellen Master Branch behoben werden muss. Im Idealfall korrigiert ihr den Fehler zuerst im Versionbranch testet ihn dort und merged in dann in den Master.

Ein einfaches kopieren der Datei vom Versionsbranch in den Master oder andersherum eignet sich in den meisten Fällen nicht, da im Master die Entwicklung schon weitergelaufen sein könnte und die Datei dann nicht mehr zum Sourcecode des Branchs passen würde.

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.