Differences

This shows you the differences between two versions of the page.

--- de:entwickler:fehlerkorrekturen_in_mehreren_versionen [2015/03/26 22:24] – Issue-Tracker fasse
+++ de:entwickler:fehlerkorrekturen_in_mehreren_versionen [2024/12/02 18:52] (current) – [Wie und wo behebe ich einen Fehler ?] greno
@@ Line 1: / Line 1: @@
-====== Sourcecode und Issue-Tracker ======
+====== Fehler beheben und neue Funktionen hinzufügen ======
 ===== Wo finde ich den Sourcecode ? =====
@@ Line 5: / Line 5: @@
 Wir entwickeln Admidio mit Hilfe der Versionsverwaltung [[http://de.wikipedia.org/wiki/Git|Git]] auf der Plattform [[http://www.github.com|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 [[https://mac.github.com/Mac|Mac]] und [[https://windows.github.com/|Windows]] an.
+GitHub bietet außerdem einen Client für [[https://mac.github.com/Mac|Mac]] und [[https://windows.github.com/|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. [[https://help.github.com/articles/about-issues/|Issue-Tracker]] nutzen um dort die gewünschte Erweiterung zu beschreiben bzw. Ideen für neue Funktionen zu sammeln.
-Hast du deine Idee als [[https://help.github.com/articles/about-issues/|Issue]] formuliert und mit uns abgestimmt, dann findest du im **Master** Branch 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 [[https://guides.github.com/activities/forking/#fork|Fork]]. Dort kannst du nun deine Erweiterung entwickeln und in den Fork [[https://guides.github.com/activities/forking/#making-changes|commiten]]. Sobald deine Erweiterung fertig ist, kannst du einen [[https://guides.github.com/activities/forking/#making-a-pull-request|Pull Request]] für unseren **Master** Branch erstellen. Diesen werden wir uns dann anschauen und besprechen um ihn dann im Idealfall zu übernehmen.
+Hast du deine Idee als [[https://help.github.com/articles/about-issues/|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 [[https://guides.github.com/activities/forking/#fork|Fork]] und von diesem Branch einen Feature-Branch. Dort kannst du nun deine Erweiterung entwickeln und in den Fork [[https://guides.github.com/activities/forking/#making-changes|commiten]]. Sobald deine Erweiterung fertig ist, kannst du einen [[https://guides.github.com/activities/forking/#making-a-pull-request|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:
@@ Line 17: / Line 17: @@
 ===== GitHub Schreibrechte =====
-Wenn ihr neu bei Admidio seit, dann solltet ihr, wie oben beschrieben, erst einmal einen [[https://guides.github.com/activities/forking/#fork|Fork]] erstellen und neue Funktionen oder Korrekturen dort vornehmen. Diese können wir dann über einen [[https://guides.github.com/activities/forking/#making-a-pull-request|Pull Request]] übernehmen. Habt ihr bereits über diese Methode Code beigetragen und entspricht dieser unseren [[de:entwickler:programmierrichtlinien|Programmierrichtlinien]], dann spricht normalerweise nichts dagegen euch auch Schreibrechte für das Admidio-Projekt in GitHub zu geben.
+Wenn du neu bei Admidio bist, dann solltest du, wie oben beschrieben, erst einmal einen [[https://guides.github.com/activities/forking/#fork|Fork]] erstellen und neue Funktionen oder Korrekturen dort vornehmen. Diese können wir dann über einen [[https://guides.github.com/activities/forking/#making-a-pull-request|Pull Request]] übernehmen. Hast du bereits über diese Methode Code beigetragen und entspricht dieser unseren [[de:entwickler:programmierrichtlinien|Programmierrichtlinien]], dann spricht normalerweise nichts dagegen dir 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 [[https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/|neuen Brach]] mit dem Präfix **feature-** und einem Funktionsnamen eurer Erweiterung anlegen.
+===== Neues Feature entwickeln =====
-  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.
+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.
-  #4711 Add new button to registration formular
-  #342  Change check of date fields
-===== Wie und wo behebe ich einen Fehler ? =====
-Wird ein Fehler in der aktuellen veröffentlichten Version gefunden, so sollte im ersten Schritt ein [[https://help.github.com/articles/about-issues/|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 [[https://help.github.com/articles/merging-branches/|merged]] in dann in den **Master**.
+  - Beschreibe auf unserer GitHub-Projektseite deine geplante Erweiterung. Dazu erfasst du einen neuen [[https://github.com/Admidio/admidio/issues|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 kennenzulernen und ggf. Anmerkungen dazu zu schreiben.
+  - Möchtest du nun die Funktion programmieren, dann wechsle zum **master** Branch und erzeuge einen [[https://help.github.com/desktop/guides/contributing/creating-a-branch-for-your-work/|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.
+  - 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.
+  - Erstelle nun aus deinem Feature-Branch (oder deinem eigenen Fork) einen [[https://help.github.com/desktop/guides/contributing/sending-a-pull-request/|Pull-Request]]. Diesen kann nun ein anderer Entwickler prüfen und //mergen//.
+===== Wie und wo behebe ich einen Fehler ? =====
-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.
+Folgende Schritte sind notwendig, wenn du einen Fehler beheben willst:
+  - Im ersten Schritt muss, wie bei neuen Funktionen auch, ein [[https://github.com/Admidio/admidio/issues|Issue]] erfasst werden, falls dieser nicht bereits schon existiert.
+  - 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**.
+  - 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//
+  - I.d.R. tritt der Fehler auch im **master** Branch auf, so dass die Commits über einen [[https://help.github.com/articles/merging-branches/|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 [[https://help.github.com/articles/fork-a-repo/|forken]] und dort die Korrektur vornehmen. Anschließend kann die Korrektur dann über einen [[https://help.github.com/articles/creating-a-pull-request/|Pull Request]] in den offiziellen Code übernommen werden.
+Hast du noch keine Schreibrechte im Admidio-Projekt auf GitHub, so kannst du das Repository erst einmal [[https://help.github.com/articles/fork-a-repo/|forken]] und dort die Korrektur vornehmen. Anschließend kann die Korrektur dann über einen [[https://help.github.com/articles/creating-a-pull-request/|Pull Request]] in den offiziellen Code übernommen werden.