📄️ Übersicht
Konventionen für die Kartenviewer API
📄️ 1. Clean code
1.1. Verwende sprechende Namen für Variablen, Konstanten und Funktionen.
📄️ 2. ES6
2.1. Verwende typeof zur Typprüfung.
📄️ 3. Backbone.js
3.1. Ein Modul besteht in der Regel aus einem Model, einer View, einem Template und einer CSS/LESS.
📄️ 4. Linting
4.1. Es wird ESLint verwendet.
📄️ 5. Unit Tests
5.1 Unittestbare Funktionen sind nur dann sauber testbar, wenn sie:
📄️ 6. JSDoc
6.1. Die Dokumentationssprache ist Englisch.
📄️ 7. Error messages
7.1. Verwende das Alerting-Modul
📄️ 8. Konfiguration
8.1. Schreibe den Code so, dass sich möglichst viel konfigurieren lässt
📄️ 9. Abwärtskompatibilität
9.1. Stelle sicher, dass alle bisherigen Konfigurationsparameter weiterhin verwendbar sind.
📄️ 10. Pre push hooks
10.1 Beachte die in der package.json konfigurierten pre-push Hooks. Diese werden bei jedem git push ausgeführt und brechen im Falle eines Errors den push ab.
📄️ 11. Multi language
11.1. Mehrsprachigkeit erweitern in allen Modulen in denen bereits Sprachdateien verwendet werden und in neuen Modulen.