Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
77 lines (52 loc) · 2.32 KB

CONTRIBUTING.md

File metadata and controls

77 lines (52 loc) · 2.32 KB
Raw

Beitragsrichtlinie / Contributing Guide

Deutsch

Vielen Dank für Ihr Interesse, zu diesem Projekt beizutragen!

Wie Sie beitragen können

  1. Bug melden: Erstellen Sie ein Issue mit dem Label bug
  2. Feature vorschlagen: Erstellen Sie ein Issue mit dem Label enhancement
  3. Code beitragen: Erstellen Sie einen Pull Request

Pull Requests

  1. Forken Sie das Repository
  2. Erstellen Sie einen Feature-Branch: git checkout -b feature/mein-feature
  3. Committen Sie Ihre Änderungen: git commit -m "Beschreibung der Änderung"
  4. Pushen Sie den Branch: git push origin feature/mein-feature
  5. Erstellen Sie einen Pull Request

Lizenz- und Rechtehinweise

Ohne ausdrückliche Zusatzregel gelten Pull Requests unter der Lizenz des Projekts (MIT).

Code-Richtlinien

  • Python: PEP 8 Stil
  • Encoding: UTF-8 für alle Dateien
  • Sprache: Code und Kommentare auf Deutsch oder Englisch
  • Keine hardcoded Pfade oder API-Keys
  • Tests: pytest (neue Funktionen mit Tests abdecken)

Erste Schritte

Prüfen Sie zuerst README.md und docs/DESIGN.md. Lokal starten: pip install -r requirements.txt, dann PYTHONPATH=src python -m cloudlockfixer (Tray) oder PYTHONPATH=src python -m cloudlockfixer.cli --help (CLI).

English

Thank you for your interest in contributing to this project!

How to Contribute

  1. Report bugs: Create an issue with the bug label
  2. Suggest features: Create an issue with the enhancement label
  3. Contribute code: Create a Pull Request

Pull Requests

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/my-feature
  3. Commit your changes: git commit -m "Description of change"
  4. Push the branch: git push origin feature/my-feature
  5. Create a Pull Request

Licensing and Contribution Terms

Unless stated otherwise, pull requests are understood to be submitted under the project's license (MIT).

Code Guidelines

  • Python: PEP 8 style
  • Encoding: UTF-8 for all files
  • Language: Code and comments in German or English
  • No hardcoded paths or API keys
  • Tests: pytest (cover new features with tests)

Getting Started

Start with README.md and docs/DESIGN.md. To run locally: pip install -r requirements.txt, then PYTHONPATH=src python -m cloudlockfixer (tray) or PYTHONPATH=src python -m cloudlockfixer.cli --help (CLI).