Vielen Dank für dein Interesse, zum TheGeekFreaks Ingest-Tool beizutragen! Wir freuen uns über jede Unterstützung.
- Überprüfe zuerst, ob der Fehler bereits gemeldet wurde
- Nutze die GitHub Issues-Funktion
- Beschreibe den Fehler so detailliert wie möglich
- Füge Screenshots oder Fehlermeldungen hinzu
- Beschreibe die Schritte zur Reproduktion
- Überprüfe, ob die Funktion bereits vorgeschlagen wurde
- Beschreibe den Nutzen der neuen Funktion
- Sei offen für Feedback und Anpassungen
- Fork das Repository
- Erstelle einen Feature-Branch (
git checkout -b feature/AmazingFeature) - Committe deine Änderungen (
git commit -m 'Add some AmazingFeature') - Push in den Branch (
git push origin feature/AmazingFeature) - Öffne einen Pull Request
- Befolge PEP 8 für Python-Code
- Nutze aussagekräftige Variablen- und Funktionsnamen
- Kommentiere komplexe Logik
- Schreibe Docstrings für Funktionen und Klassen
- Füge Tests für neue Funktionen hinzu
- Stelle sicher, dass alle Tests erfolgreich sind
- Nutze pytest für das Testen
- Nutze klare und beschreibende Commit-Nachrichten
- Beginne mit einem Verb im Imperativ
- Halte die erste Zeile unter 50 Zeichen
- Füge bei Bedarf eine detaillierte Beschreibung hinzu
Beispiel:
Add automatic file type detection
- Implement MIME type detection
- Add file extension mapping
- Update documentation
- Aktualisiere die README.md wenn nötig
- Aktualisiere die Versionsnummer in relevanten Dateien
- Füge deine Änderungen zum CHANGELOG.md hinzu
- Der Pull Request wird nach Review und erfolgreichen Tests gemerged
- Sei respektvoll und inklusiv
- Hilf anderen Entwicklern
- Teile dein Wissen
- Befolge den Verhaltenskodex
Bei Fragen kannst du:
- Ein Issue erstellen
- Uns auf Discord kontaktieren
- Eine E-Mail an support@thegeekfreaks.de senden
Nochmals vielen Dank für deinen Beitrag! 🚀