Wir würden uns freuen, wenn Sie etwas zu KoliBri beitragen und dabei helfen würden, es noch besser zu machen, als es heute ist! Als Mitwirkender bitten wir Sie, die folgenden Richtlinien zu befolgen:
Helfen Sie uns, KoliBri offen und integrativ zu halten. Bitte lesen und folgen Sie unserer Code of Conduct.
Bitte erstellen Sie keine Issue-Tickets für allgemeine Supportfragen. Wir möchten das Ticketsystem für die Nachverfolgung von Fehlerberichten und Funktionsanfragen verwenden.
Stattdessen empfehlen wir als erstes bei Stack Overflow nachzuschauen, ob jemand anderes die Frage oder das Problem schon gelöst hat. Gerne können dort auch neue Fragen mit dem Tag kolibri erstellt werden.
Um Ihre und unsere Zeit zu sparen, werden wir alle allgemeinen Fragen im Ticketsystem schließen und die Fragenden an Stack Overflow weiterleiten.
Wenn Sie gerne mit uns Kontakt aufnehmen wollen, dann schreiben Sie uns entweder eine E-Mail an kolibri@itzbund.de oder nutzen Sie unseren Discord-Chat.
Wenn Sie einen Fehler im Quellcode finden, dann können Sie diesen an unser Ticketsystem melden.
Noch besser wäre es, wenn Sie uns eine Lösung als Pull Request vorschlagen.
Sie können neue Funktionen anfordern, indem Sie ein Problem an unser Ticketsystem senden. Wenn Sie gerne eine neue Funktion implementieren möchten, dann beachten Sie bitte die folgenden Schritte für das weitere Vorgehen:
- Es ist hilfreich vor dem Implementieren das Architekturkonzept zu KoliBri zu lesen.
- Bei größeren Neuerungen legen Sie bitte ein Ticket mit der Beschreibung der neuen Funktion an.
- Bei kleinen Neuerungen können Sie die Implementierung direkt als Pull Request anbieten und begründen.
- pnpm installieren
- Konsole im Projekt root öffnen
- Alle Pakete installieren mit "pnpm i"
- in gewüschtes Projekt wechseln
- Projekt starten mit "pnpm start"