CONTRIBUTING.md

Mitwirken an Inventarium

Vielen Dank für Ihr Interesse an der Mitarbeit am Inventarium-Projekt! 🎉

Verhaltenskodex

Dieses Projekt und alle Mitwirkenden unterliegen unserem Verhaltenskodex. Mit Ihrer Teilnahme verpflichten Sie sich, diesen einzuhalten.

Wie kann ich beitragen?

🐛 Fehler melden

Fehler sollten über den Issue Tracker gemeldet werden. Bitte beachten Sie dabei:

1. Suchen Sie zuerst nach bestehenden Issues
2. Nutzen Sie die Issue-Vorlage
3. Beschreiben Sie detailliert:
   • Wie der Fehler reproduziert werden kann
   • Was das erwartete Verhalten war
   • Was tatsächlich passiert ist
   • Systemumgebung (Betriebssystem, Python-Version etc.)

💡 Neue Funktionen vorschlagen

Haben Sie eine Idee für eine neue Funktion?

1. Erstellen Sie ein Issue mit dem Label "enhancement"
2. Beschreiben Sie:
   • Den Anwendungsfall
   • Die erwarteten Vorteile
   • Mögliche Alternativen

🔧 Code beitragen

1. Fork erstellen und lokal klonen
2. Branch erstellen: git checkout -b feature/IhrFeature
3. Änderungen committen:
   • Aussagekräftige Commit-Nachrichten
   • Ein Commit pro logische Änderung
4. Tests hinzufügen für neue Funktionen
5. Pull Request erstellen

Commit-Nachrichten

Bitte folgen Sie diesem Format:

typ(bereich): kurze beschreibung

Detaillierte Beschreibung der Änderungen

Typen:

• feat: Neue Funktion
• fix: Fehlerbehebung
• docs: Dokumentation
• style: Formatierung
• refactor: Code-Umstrukturierung
• test: Tests
• chore: Wartungsarbeiten

📝 Coding Standards

• Python: PEP 8 Stilrichtlinien
• HTML/CSS: Bootstrap 5 Konventionen
• JavaScript: ESLint-Konfiguration beachten
• Kommentare: Deutsch für Benutzer-sichtbare Texte, Englisch für technische Kommentare

✅ Pull Request Checkliste

• Tests hinzugefügt/aktualisiert
• Dokumentation aktualisiert
• Code entspricht den Stilrichtlinien
• Commit-Nachrichten folgen den Konventionen
• Branch ist auf dem neuesten Stand mit main

🔄 Entwicklungsprozess

1. Issue auswählen oder erstellen
2. Branch erstellen vom main
3. Entwickeln und testen
4. Pull Request erstellen
5. Code Review abwarten
6. Änderungen einarbeiten falls nötig
7. Merge nach Freigabe

🧪 Tests

• Führen Sie pytest aus
• Stellen Sie sicher, dass alle Tests bestehen
• Neue Funktionen benötigen Tests

📚 Dokumentation

• Aktualisieren Sie die Dokumentation bei Änderungen
• Nutzen Sie klare, verständliche Sprache
• Fügen Sie Beispiele hinzu wo sinnvoll

❓ Fragen?

Bei Fragen:

1. Prüfen Sie die FAQ
2. Erstellen Sie ein Issue mit dem Label "question"
3. Kontaktieren Sie die Maintainer

📜 Lizenz

Mit Ihrem Beitrag stimmen Sie zu, dass Ihre Änderungen unter der gleichen MIT-Lizenz wie das Projekt veröffentlicht werden.