Mit diesem Formular können Sie fehlende, unklare oder fehlerhafte Inhalte in der Dokumentation melden und Verbesserungsvorschläge machen. Ihr Feedback hilft uns, die Qualität und Vollständigkeit kontinuierlich zu verbessern.
Einführung
Die vorliegende Entwicklungsrichtlinie unterstützt die Entwicklung von Extensions in Kundenprojekten mit einheitlichen Vorgaben für die Werkzeuge die wir verwenden sowie die Art und Weise in der wir Quellcode schreiben.
Die Kernfunktion der Entwicklungsrichtlinie ist in einem Kundenprojekt sowie übergreifend für alle Kundenprojekte einen einheitlichen Standard für Wartbarkeit und Lesbarkeit herzustellen. Folgende Kapitel beschreiben diese Aspekte jeweils im Detail:
Die Vorgaben in der Entwicklungsrichtlinie sind grundsätzlich bindend. Etwaige Entscheidungsspielräume sind entsprechend gekennzeichnet. Bei einer strittigen Implementierung, für die die Entwicklungsrichtlinie keine klare Aussage enthält, entscheidet der Code Reviewer.
Wichtig
Die Intention der Entwicklungsrichtlinie gilt auch dann, wenn keine konkrete Regel zu einem Sachverhalt vorliegt. Entwickler und Reviewer entscheiden im Zweifel immer unter dem Gesichtspunkt: "Ist die Lösung lesbar und wartbar für zukünftige Änderungen und zukünftiges Troubleshooting?".
Die Entwicklungsrichtlinie in vorliegender Form ersetzt ab dem 01.01.2022 bisherige Vorgaben. Code, der vor dem Stichtag entstanden ist, muss nicht ohne besonderen Grund rückwirkend angepasst werden. Code, der nach dem Stichtag entsteht, muss der Richtlinie folgen.
Hinweis
Die Entwicklungsrichtlinie für die Entwicklung von AL Extensions in Kundenprojekten steht über die unitop Dokumentation generell GOB-Mitarbeitern und dafür freigeschalteten Kundenmitarbeitern zur Verfügung. Die Freischaltung für Dritte, wie z. B. im Kundenprojekt tätigen Partnern, muss durch GOB je Einzelfall entschieden werden. Bitte im Bedarfsfall an den GOB Projektleiter wenden.
Mitwirkung
Die Vorgaben und Hinweise aus der vorliegenden Entwicklungsrichtlinie werden fortlaufend weiterentwickelt. Hinweise zu inhaltlichen Fehlern oder fehlenden Inhalten nehmen wir immer gerne entgegen!
- GOB-Mitarbeiter: Wenden sich entweder an die Entwicklungsleitung oder erfassen direkt Bugs für die Dokumentation. Eine entsprechende Arbeitsanweisung liegt im Prozessportal: Erfassen von Bugs
- Mitarbeiter des Kunden und/oder Dritten wenden sich bitte an den GOB Projektleiter.
Änderungsverlauf
Jüngerer Änderungsverlauf der letzten ca. 12 Monate. Ältere Änderungen werden hier nicht mehr dargestellt.
| Datum | Änderung |
|---|---|
| 12.04.2022 | Verwendung von git bearbeitet -> veränderte Strategie im Branching |
| 29.01.2022 | Coderichtlinien erweiterte Regeln für den Umgang mit Subscribern |
| 18.11.2021 | Überführung aus der ehemaligen internen Richtlinie |