Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
84 lines (63 loc) · 1.66 KB

CONTRIBUTING.md

File metadata and controls

84 lines (63 loc) · 1.66 KB

Contributing to BNetzA Data Repository

Wir freuen uns über Beiträge zu diesem Repository! Hier finden Sie Informationen, wie Sie zum Projekt beitragen können.

Arten von Beiträgen

Datenqualität

  • Fehlerhafte Daten melden
  • Datenvalidierung verbessern
  • Neue Datenquellen vorschlagen

Code-Verbesserungen

  • Bugs beheben
  • Performance optimieren
  • Neue Features implementieren

Dokumentation

  • README verbessern
  • API-Dokumentation erweitern
  • Beispiele hinzufügen

Entwicklungsumgebung

Voraussetzungen

  • Python 3.8+
  • pandas, numpy, requests

Setup

git clone https://github.com/EnBW-B2E2/bnetza-data.git
cd bnetza-data
pip install -r requirements.txt

Tests ausführen

python -m pytest tests/

Pull Request Prozess

  1. Fork des Repositories
  2. Feature-Branch erstellen
  3. Änderungen implementieren
  4. Tests hinzufügen/aktualisieren
  5. Pull Request erstellen

Code-Standards

Python Code

  • PEP 8 Style Guide befolgen
  • Type Hints verwenden
  • Docstrings für alle Funktionen
  • Fehlerbehandlung implementieren

Datenformate

  • CSV mit UTF-8 Encoding
  • ISO 8601 Zeitstempel
  • Konsistente Spaltenamen
  • Vollständige Metadaten

Datenvalidierung

Automatische Checks

  • Zeitreihen-Kontinuität
  • Wertebereiche prüfen
  • Fehlende Werte identifizieren
  • Duplikate erkennen

Manuelle Validierung

  • Plausibilitätsprüfung
  • Vergleich mit Referenzdaten
  • Qualitätsbewertung

Lizenz

Durch Beiträge zu diesem Repository stimmen Sie zu, dass Ihre Beiträge unter der MIT-Lizenz lizenziert werden.

Kontakt

Bei Fragen oder Problemen erstellen Sie bitte ein GitHub Issue oder kontaktieren Sie das Entwicklungsteam.