Entwickler FAQ
Diese Seite enthält einige Fragen und Antworten(FAQs) im Zusammenhang mit der Entwicklung von Dolibarr. Für Fragen und Antworten zur Nutzung besuchen Sie bitte die Seite FAQ Benutzer .
Wie man offizieller Entwickler wird
In der Galaxie des Dolibarr-Projekts gibt es mehrere Akteure mit unterschiedlichen Niveaus / Graden. Die Anzahl der Entwickler ist wichtig, so dass Beiträge und Änderungen kontrolliert und validiert werden müssen (sowohl für funktionale Bedürfnisse als auch für die Codierung). Aus diesem Grund ist der Schreibzugriff auf den Quellcode (GIT) begrenzt und wird durch eine Organisation geregelt, die im Folgenden beschrieben wird. Jeder Entwickler hat einen Rang, der sich nach dem Dienstalter und der Vergangenheit richtet. Der Grad der Autorisierung einer Person am Projekt steigt mit den Stufen der Beförderung im Grad.
Der Werdegang eines Dolibarr-Entwicklers durchläuft diese Stufen, die durch einen Titel klassifiziert werden, der Science-Fiction-Fans bekannt ist. Hier sind die Stufen. Es ist wichtig zu verstehen, dass diese Organisation den einzigen Zweck hat, die Qualität von Dolibarr zu verbessern, und es ist notwendig, dass sie rigoros angewendet wird.
Die Ränge der Mitwirkenden an der Dolibarr-Projekt, und was zu tun, um diesen Rang zu erreichen, sind in Seite Dolibarr-Projekt im Kapitel Entwickler Rollen definiert.
Das aktuelle Entwickler-Team
Auf der Seite Dolibarr-Projekt finden Sie eine Liste der Personen, die derzeit an Dolibarr arbeiten, mit ihrem aktuellen Dienstgrad.
Starte (d)eine Entwicklung
Lesen Sie die Entwicklerdokumentation vollständig durch, um alle Regeln und Grundsätze, die Entwicklern auferlegt werden, zu verinnerlichen. Sie können auch die folgenden FAQs lesen
Abrufen/Aktualisieren von Projektquellen
Siehe die Seite FAQ Projektquellen abrufen und aktualisieren.
Wie man eine neue Benutzeroberfläche erstellt (Skin/Theme)
Siehe hierzu die Seite Skins
Wie entwickle ich mein eigenes Modul
Um ein eigenes Nummerierungsmodul zu entwickeln, siehe Nummerierungsmodul erstellen.
Um eine eigene Dokumentvorlage, PDF oder eine sonstige Vorlage zu entwickeln, siehe PDF-Dokumentvorlage erstellen oder ODT-Dokumentvorlage erstellen.
Um ein ganzes Funktionsmodul (Bildschirme, Tabellen) zu entwickeln, siehe dazu die Seite Modulentwicklung.
Wie man eine Übersetzung hinzufügt oder verändert.
Siehe dazu die Seite Übersetzer-Dokumentation.
Mein Rechnungsnummerierungssystem im laufenden Betrieb ändern
Wenn das neue Nummerierungssystem nicht mit dem alten kollidiert, können Sie die Nummerierungsregel ändern, indem Sie das Menü Einstellungen - Module/Anwendungen - Rechnungen aufrufen und und nehmen Sie eine neue Vorlage aus der Liste.
Wenn das neue System einen Konflikt verursacht, müssen Sie Ihre bestehenden Referenzen neu nummerieren. Dies kann mit einer SQL-Abfrage geschehen. Um beispielsweise von Jupiter (FYYYYMM99) to Terre (FAYYMM-999)
If the new rule can create conflicts with old one, it will be necessary to rename old existing references. This can be done by a SQL request. For example, to go from numbering module Jupiter (FYYYYMM99) to Terre (FAYYMM-999), zu wechseln, können Sie die folgende Abfrage ausführen:
update llx_facture set facnumber=concat('FA',substr(facnumber,4,4),'-',substr(facnumber,8))
where facnumber like 'F%' and facnumber not like 'FA%';
For example, to rename references from model FAYYMM999 to Terre (FAYYMM-999), you can run the following request:
update llx_facture set facnumber=concat('FA',substr(facnumber,3,4),'-',substr(CONCAT('0000',substr(facnumber,7)),-4))
where facnumber like 'FA%' and facnumber not like '%-%';
Einen Patch, eine Verbesserung einreichen oder an der Entwicklung teilnehmen
Wenn Sie herausfinden möchten, wie Sie mit der Entwicklung von Dolibarr beginnen oder dazu beitragen können, lesen Sie das Kapitel 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éveloppeur - Offizieller Entwickler werden für die verschiedenen Dienstgrade).
- Wenn du keinen direkten Schreibzugriff auf das Referenz-Repository hast (dein Rang ist also Jedi oder Admiral oder 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:
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 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 cygwin bereitgestellt) wie folgt ausführen:
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
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).
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:
patch -u -p0 -d . < monfichier.patch
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
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 https://savannah.nongnu.org/mail/?group=dolibarr). 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.
Wie man ein Modul verpackt und einsetzt
Siehe Seite Modulentwicklung.
Dieser Prozess funktioniert auch, um ein Paket zu erstellen und es auf dem Marktplatz https://www.dolistore.com einzureichen.
Wie kann man über Neuigkeiten und Entwicklungen im Dolibarr-Projekt informiert werden?
Siehe FAQ-Seite Wie kann ich über Neuigkeiten zu Dolibarr informiert werden?