265
edits
Entwickler FAQ: Difference between revisions
Jump to navigation
Jump to search
→Einen Patch, eine Verbesserung einreichen oder an der Entwicklung teilnehmen
Gschratzer (talk | contribs) |
Gschratzer (talk | contribs) Tag: 2017 source edit |
||
| Line 64: | Line 64: | ||
Wenn Sie herausfinden möchten, wie Sie mit der Entwicklung von Dolibarr beginnen oder dazu beitragen können, lesen Sie das Kapitel [[Developer FAQ#How to be an official developer|FAQ_Entwickler#Wie werde ich offizieller Entwickler]]. Wenn Ihr Patch bereits fertig ist und Sie ihn verbreiten wollen, ist dieses Kapitel für Sie. | Wenn Sie herausfinden möchten, wie Sie mit der Entwicklung von Dolibarr beginnen oder dazu beitragen können, lesen Sie das Kapitel [[Developer FAQ#How to be an official developer|FAQ_Entwickler#Wie werde ich offizieller Entwickler]]. Wenn Ihr Patch bereits fertig ist und Sie ihn verbreiten wollen, ist dieses Kapitel für Sie. | ||
==Mit einem GitHub-Konto== | |||
Der Zugang zur Hinterlegung von Lesequellen ist öffentlich. Das Einreichen von Beiträgen hängt jedoch von Ihrer Stufe im Projekt ab. | |||
* | *Wenn du einen (äußerst seltenen) Yoda-Rang und damit direkten Schreibzugriff auf das Referenzrepository hast, nutze ihn | ||
[[FAQ_D%C3%A9veloppeur#Comment_devenir_d.C3.A9veloppeur_officiel|FAQ Développeur - Offizieller Entwickler werden]] für die verschiedenen Dienstgrade). | |||
* | *Wenn du keinen direkten Schreibzugriff auf das Referenz-Repository hast (dein Rang ist also [[Developer FAQ#Soldier|Jedi]] oder [[Developer FAQ#Soldier|Admiral]] oder [[Developer FAQ#Soldier|Soldier]]), dann musst du GitHub benutzen, indem du das Repository auf deinem Konto "forkest" und dann einen « Pull Request » von deinem Zweig auf das Haupt-Repository stellst. Dies ist die sauberste und leistungsfähigste empfohlene Methode. Siehe für weitere Informationen die Seite https://wiki.dolibarr.org/index.php/FAQ_Get,update_GIT_project_sources | ||
Anmerkung: Wenn Sie mit dem GIT-Tool nicht vertraut sind und Ihre Änderung klein ist (eine oder zwei Dateien), können Sie die Datei einfach online bearbeiten, indem Sie über das GitHub-Webinterface auf Ihr GitHub-Konto und Ihr "Forkiertes" Repository zugreifen. Sobald Sie die Änderung vorgenommen haben, können Sie die Funktion Submit Pull Request verwenden, um sie dem Projekt vorzuschlagen. Ein Validator wird sie dann mühelos integrieren, sofern sie zulässig ist. | |||
*Das folgende Verfahren bleibt eine technisch mögliche Alternative, wird aber nur noch für sehr kleine Änderungen praktiziert... | |||
==ohne GitHub-Konto== | |||
Ohne GitHub-Konto ist es notwendig, Ihre Patch-Datei zu erstellen und per E-Mail an die Entwickler-Mailingliste '''dolibarr-dev''' zu schicken (siehe hier {TemplateURLMLDev}}). Hier ist das Verfahren zum Erzeugen einer Patch-Datei: | |||
''Sous tout OS:'' [[Image:Logo_windows.png|20px]] [[Image:Logo_ubuntu.png|20px]] [[Image:Logo_apple.png|20px]] | |||
Hier ist die ''Pro-Methode'', nach der Sie arbeiten müssen, um eine solche Patch-Datei erzeugen zu können: | |||
- Ein Verzeichnis haben, das die Referenzversion von Dolibarr enthält (Ergebnis des GIT-Updates oder einfach die Baumstruktur, die sich aus dem Entpacken eines tgz-Snapshots von Dolibarr ergibt). Wir werden dieses Verzeichnis '''alte_rep''' nennen. Sie können den Snapshot der aktuellen Dev-Version auf der [http://www.dolibarr.org/downloads/ offizielle Dolibarr-Website - Downloadbereich - Entwicklungsversion] abrufen. | |||
- Ein weiteres Verzeichnis haben, das den Baum von Dolibarr enthält, in dem Sie aber Ihre Änderungen vornehmen oder vorgenommen haben. Wir werden dieses Verzeichnis '''new_rep''' nennen. | |||
Um die Patch-Datei zu erzeugen, müssen Sie dann nur den Befehl | |||
'''diff''' (unter Linux Standard, unter Windows in [http://www.cygwin.org/cygwin cygwin] bereitgestellt) wie folgt ausführen: | |||
<source lang="bash"> | |||
diff -BNaur --exclude=CVS --exclude="*.patch" --exclude=".#*" --exclude="*~" --exclude="*.rej" \ | |||
--exclude="*.orig" --exclude="*.bak" --exclude=conf.php --exclude=documents \ | |||
ancien_rep nouveau_rep > mypatch.patch | |||
</source> | |||
Ein ksh Skript, das diesen Befehl ausführt, ist im Verzeichnis '''build/patch''' verfügbar. | |||
Senden Sie Ihren Patch auf der ML an die Adresse '''dolibarr-dev@nongnu.org'''. | |||
Die Integration Ihres Patches kann zwar nicht garantiert werden, ebenso wenig wie die Zeit, aber wenn der Patch genau nach diesem Verfahren erstellt wird, ist die Wahrscheinlichkeit groß, dass er zumindest getestet wird (andernfalls ist die Wahrscheinlichkeit nahe 0). | |||
''Sous Windows:'' [[Image:Logo_windows.png|20px]] | |||
Wenn Sie unter Windows arbeiten, ist eine ''weniger prominente Methode'', die aber zum gleichen Ergebnis führt, die folgende. Installieren Sie das ausgezeichnete Open-Source-Vergleichstool Winmerge, das Patches im Format ''diff -Naur'' erstellen kann. Vergleichen Sie dazu mit Winmerge die Referenzdatei und die geänderte Datei und wählen Sie im Menü ''"Tools - Generate patch"'' (''Retuschen erzeugen'' in der deutschen Version). Geben Sie einen Dateinamen wie ''"resultat.patch"'' ein, aktivieren Sie das Kästchen ''"Append"'' und wählen Sie die Option ''"Format Unified"'' (''Stil: vereinheitlicht'' in der deutschen Version). Klicken Sie auf ''"Ok"''. | |||
Wiederholen Sie dies eventuell für jede geänderte Datei. | |||
Am Ende erhalten Sie eine schöne Datei ''result.patch'', die alle Änderungen im richtigen Format enthält. | |||
''Testen/Anwenden eines Patches''. | |||
Um eine Patch-Datei auf eine unveränderte Version anzuwenden, damit die in der Patch-Datei beschriebenen Änderungen übernommen werden, können Sie das Dienstprogramm '''patch''' verwenden. | |||
Angenommen, Sie haben ein Verzeichnis mit den Quellen einer unveränderten Version von Dolibarr auf einem Server. Um den Patch anzuwenden, legen Sie ihn in das Stammverzeichnis von Dolibarr und führen den Befehl aus: | |||
<source lang="bash"> | |||
patch -u -p0 -d . < monfichier.patch | |||
</source> | |||
<nowiki>Zu Ihrer Information: -p0 verwendet den gesamten Pfad, wie er in der Patch-Datei angegeben ist, um die zu ändernden Dateien in Ihrem Quellbaum zu finden (-pn entfernt die ersten n Ebenen des Baums). | |||
-d erlaubt es, den relativen Pfad zu dem zu patchenden Ordner anzugeben. | |||
< ermöglicht es, den Pfad zu der zu verwendenden Quelldatei anzugeben (der Patch muss im einheitlichen Format vorliegen). | |||
-u ermöglicht die Angabe, dass der Patch im vereinheitlichten Format vorliegt</nowiki> | |||
''Patch per E-Mail versenden'' | |||
Sobald Ihre Patch-Datei erstellt und erfolgreich getestet wurde, können Sie sie an die Entwickler-Mailingliste '''dolibarr-dev''' von Dolibarr senden (Sehen Sie hier dafür {{TemplateURLMLDev}}). | |||
Diese Mailingliste wird von allen Hauptentwicklern gelesen, aber wir können nicht garantieren, dass der Patch aufgenommen wird, das hängt von seiner Qualität und den anderen aktuellen Entwicklungsprioritäten ab. | |||
=How to package and deploy a module= | =How to package and deploy a module= | ||