Vielen Dank für dein Interesse, zu ByteStorm beizutragen! Bitte beachte die folgenden Richtlinien, um einen reibungslosen Ablauf zu gewährleisten.
- Beiträge sollten klar, verständlich und gut dokumentiert sein.
- Halte dich an den bestehenden Code-Stil und die Projektstruktur.
- Schreibe Code möglichst effizient und vermeide unnötige Abhängigkeiten.
- Teste deine Änderungen gründlich, bevor du einen Pull Request erstellst.
- Beschreibe den Fehler so genau wie möglich.
- Füge relevante Log-Ausgaben, Screenshots oder Beispielkonfigurationen bei.
- Gib an, welche Version(en) betroffen sind.
- Beschreibe das gewünschte Feature und den Nutzen.
- Prüfe vorher, ob es bereits ähnliche Vorschläge gibt.
- Forke das Repository und arbeite in einem eigenen Branch.
- Beschreibe im Pull Request, was geändert wurde und warum.
- Vermeide große, unübersichtliche Änderungen – kleine, thematisch getrennte Pull Requests sind bevorzugt.
- Stelle sicher, dass alle Tests erfolgreich durchlaufen.
- Schreibe in Java und halte dich an die Java-Konventionen.
- Benutze sprechende Namen für Klassen, Methoden und Variablen.
- Dokumentiere komplexe Logik mit Kommentaren.
- Entferne nicht verwendeten Code.
- Sei respektvoll und freundlich im Umgang miteinander.
- Nutze die Issues und Pull Requests für Diskussionen rund um das Projekt.
Mit deinem Beitrag erklärst du dich damit einverstanden, dass dein Code unter der Lizenz dieses Projekts veröffentlicht wird.
Vielen Dank für deine Unterstützung!