Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
107 lines (78 loc) · 3.97 KB

CONTRIBUTING.md

File metadata and controls

107 lines (78 loc) · 3.97 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

Developer Certificate of Origin (DCO)

Dieses Projekt verwendet den Developer Certificate of Origin (DCO). Bitte signieren Sie jeden Commit mit --signoff:

git commit --signoff -m "Beschreibung der Änderung"

Damit bestätigen Sie, dass Sie das Recht haben, den Code unter der Projektlizenz einzureichen.

Code-Richtlinien & Quality Gates

  • Python: PEP 8 Stil mit ruff (Konfiguration in pyproject.toml)
  • Encoding: UTF-8 ohne BOM für alle Dateien
  • Sprache: Code und Kommentare auf Deutsch oder Englisch
  • Keine hardcoded Pfade oder API-Keys
  • Quality Gates vor Commit/PR:
    1. pytest — Gesamte Testsuite muss zu 100% bestehen.
    2. ruff check . — Keine Linting- oder Formatierungsfehler.
    3. python -m compileall -q . — Saubere Bytecode-Kompilierung.
    4. git diff --check — Keine Whitespace- oder Zeilenende-Fehler.
  • Version-Freeze-Disziplin (T-20260920-167562623): Die Version 1.1.4 bleibt strikt eingefroren. Keine eigenmächtigen Versionserhöhungen; alle Änderungen werden unter ## [Unreleased] im CHANGELOG.md dokumentiert.
  • Lokale Entwicklung (Plan D): Entwicklung erfolgt im lokalen Git-Klon (C:\_Local_DEV\repos\PDFtoPDFocr).

Erste Schritte

git clone https://github.com/doc-bricks/PDFtoPDFocr.git
cd PDFtoPDFocr
pip install -r requirements.txt
python -m pip install -r requirements-dev.txt
python -m pytest
python PDFtoPDFocr_2.py

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

Developer Certificate of Origin (DCO)

This project uses the Developer Certificate of Origin (DCO). Please sign off every commit with --signoff:

git commit --signoff -m "Description of change"

This certifies that you have the right to submit the code under the project license.

Code Guidelines & Quality Gates

  • Python: PEP 8 style enforced with ruff (configuration in pyproject.toml)
  • Encoding: UTF-8 without BOM for all files
  • Language: Code and comments in German or English
  • No hardcoded paths or API keys
  • Pre-Commit Quality Gates:
    1. pytest — 100% of the test suite must pass.
    2. ruff check . — Zero linting or formatting violations.
    3. python -m compileall -q . — Clean bytecode compilation with no syntax errors.
    4. git diff --check — Zero whitespace or carriage return issues.
  • Version Freeze Policy (T-20260920-167562623): Version 1.1.4 is strictly frozen. No unauthorized release bumps; all modifications must be tracked under ## [Unreleased] in CHANGELOG.md.
  • Local Development (Plan D): Canonical source repository is the local git clone (C:\_Local_DEV\repos\PDFtoPDFocr).

Getting Started

git clone https://github.com/doc-bricks/PDFtoPDFocr.git
cd PDFtoPDFocr
pip install -r requirements.txt
python -m pip install -r requirements-dev.txt
python -m pytest
python PDFtoPDFocr_2.py