Beitragen
openkring lebt von Beiträgen.
Ob Fehlerbericht, Übersetzung, Dokumentation oder neue Funktion — jeder Beitrag zählt. Diese Seite zeigt, wie du den Quelltext holst, lokal entwickelst und deine Änderungen einreichst.
Schritt 1
Quelltext holen.
openkring ist ein Nx-Monorepo. Du brauchst Node.js 20 und pnpm. Klone das Repository und installiere die Abhängigkeiten.
# Repository klonen
git clone https://github.com/openkring/okr.git
cd openkring
# Abhängigkeiten installieren
pnpm installSchritt 2
Lokal entwickeln.
Nx steuert alle Aufgaben — bauen, testen, linten. Ersetze <app> bzw. <project> durch die gewünschte Anwendung oder Bibliothek.
pnpm nx serve <app> # Entwicklungsserver starten
pnpm nx build <app> # Produktions-Build erzeugen
pnpm run test <project> # Unit-Tests ausführen (Vitest)
pnpm run lint # Den ganzen Workspace lintenVor dem Commit
Eine Aufgabe gilt erst als erledigt, wenn sie sauber kompiliert. Stelle sicher, dass npx tsc --noEmit und der Lint fehlerfrei durchlaufen.
Konventionen
Damit Beiträge zusammenpassen.
openkring folgt durchgehend modernen Angular-Mustern. Wer beiträgt, hält sich an diese Grundregeln.
Moderne Angular-Patterns
Signals und Inputs statt Legacy-Patterns. Bestehende Muster im Code zuerst prüfen.
Standalone & zoneless
Ausschliesslich Standalone Components, keine NgModules, keine zone.js-Abhängigkeit.
Schichten respektieren
data-access, feature, ui und util sauber getrennt halten — keine Abkürzungen quer durch die Schichten.
Tests für Werkzeuge
Jede util-Funktion bekommt Unit-Tests mit Vitest.
Streng typisiert
TypeScript im strict-Modus. Build-Artefakte gehören nie in den Quellbaum.
Schema mit Bedacht
Änderungen am Datenmodell vorab abstimmen — sie betreffen die ganze Plattform.
Schritt 3
Beiträge einreichen.
Issue öffnen
Melde einen Fehler oder stelle eine Idee zur Diskussion, bevor du grösseren Code schreibst.
Branch erstellen
Eine fokussierte Änderung pro Branch — das macht die Prüfung einfach.
Pull Request stellen
Beschreibe das „Warum", nicht nur das „Was". Tests und Lint müssen grün sein.
Review einarbeiten
Feedback aufnehmen, bis der Pull Request bereit zum Merge ist.
Auch ohne Code
Es gibt viele Wege zu helfen.
Fehler melden
Probleme genau beschreiben
Übersetzen
Sprachen ergänzen, Texte prüfen
Dokumentieren
Anleitungen klarer machen
Testen
Neue Funktionen ausprobieren
Noch unsicher, wo du anfangen sollst?
Schau in die offenen Issues — oder verstehe zuerst, wie das Projekt eingebettet ist.