|
| 1 | +# Beitragsrichtlinien (Contributing) |
| 2 | + |
| 3 | +Vielen Dank für dein Interesse an diesem Projekt! |
| 4 | +Diese Richtlinien helfen dabei, Beiträge übersichtlich, verständlich und effizient zu gestalten. |
| 5 | + |
| 6 | +Dieses Projekt ist ein **persönliches / schulisches Python-Projekt**. Beiträge sind willkommen, solange sie die folgenden Regeln einhalten. |
| 7 | + |
| 8 | +--- |
| 9 | + |
| 10 | +## 📋 Allgemeine Regeln |
| 11 | + |
| 12 | +- Sei respektvoll und freundlich |
| 13 | +- Halte dich an den [Code of Conduct](CODE_OF_CONDUCT.md) |
| 14 | +- Schreibe klaren, verständlichen Code |
| 15 | +- Keine sensiblen Daten (API-Keys, echte Bankdaten) einreichen |
| 16 | + |
| 17 | +--- |
| 18 | + |
| 19 | +## 🐛 Issues erstellen |
| 20 | + |
| 21 | +Bevor du ein neues Issue erstellst: |
| 22 | +- Prüfe, ob das Problem bereits existiert |
| 23 | +- Nutze die bereitgestellten **Issue-Vorlagen** |
| 24 | + |
| 25 | +Ein gutes Issue enthält: |
| 26 | +- Eine klare Beschreibung des Problems |
| 27 | +- Schritte zur Reproduktion |
| 28 | +- Erwartetes und tatsächliches Verhalten |
| 29 | +- Angaben zur Umgebung (OS, Python-Version, Terminal) |
| 30 | + |
| 31 | +--- |
| 32 | + |
| 33 | +## ✨ Feature Requests |
| 34 | + |
| 35 | +Feature-Ideen sind willkommen! |
| 36 | + |
| 37 | +Bitte beschreibe: |
| 38 | +- Welches Problem gelöst werden soll |
| 39 | +- Deine vorgeschlagene Lösung |
| 40 | +- Mögliche Alternativen |
| 41 | +- (Optional) Umsetzungsideen |
| 42 | + |
| 43 | +Nutze dafür die **Feature-Request-Vorlage**. |
| 44 | + |
| 45 | +--- |
| 46 | + |
| 47 | +## 🔀 Pull Requests |
| 48 | + |
| 49 | +### Bevor du einen Pull Request erstellst: |
| 50 | +- Erstelle einen eigenen Branch |
| 51 | +- Stelle sicher, dass der Code fehlerfrei läuft |
| 52 | +- Teste Änderungen mit der `example.csv` |
| 53 | +- Aktualisiere die Dokumentation, falls nötig |
| 54 | + |
| 55 | +### Ein Pull Request sollte enthalten: |
| 56 | +- Eine klare Beschreibung der Änderung |
| 57 | +- Den Zweck der Änderung |
| 58 | +- Hinweise zu Tests oder Einschränkungen |
| 59 | + |
| 60 | +Bitte nutze die **Pull-Request-Vorlage**. |
| 61 | + |
| 62 | +--- |
| 63 | + |
| 64 | +## 🔒 Sicherheit & Datenschutz |
| 65 | + |
| 66 | +- **Keine echten Bankdaten** |
| 67 | +- **Keine API-Schlüssel** |
| 68 | +- Nutze nur Beispiel- oder Testdaten |
| 69 | +- Sensible Dateien müssen in `.gitignore` stehen |
| 70 | + |
| 71 | +--- |
| 72 | + |
| 73 | +## 🛠 Code-Stil |
| 74 | + |
| 75 | +- Python 3 |
| 76 | +- Verständliche Variablennamen |
| 77 | +- Kurze, sinnvolle Funktionen |
| 78 | +- Docstrings bei größeren Funktionen sind erwünscht |
| 79 | + |
| 80 | +--- |
| 81 | + |
| 82 | +## 📞 Kontakt |
| 83 | + |
| 84 | +Bei Fragen oder Unsicherheiten: |
| 85 | +- Nutze ein GitHub Issue |
| 86 | +- Oder kontaktiere den Repository-Betreiber direkt |
| 87 | + |
| 88 | +--- |
| 89 | + |
| 90 | +Danke für deinen Beitrag! 🚀 |
0 commit comments