|
| 1 | +# Beitragsrichtlinie / Contributing Guide |
| 2 | + |
| 3 | +## Deutsch |
| 4 | + |
| 5 | +Vielen Dank fuer Ihr Interesse, zu diesem Projekt beizutragen! |
| 6 | + |
| 7 | +### Wie Sie beitragen koennen |
| 8 | + |
| 9 | +1. **Bug melden:** Erstellen Sie ein Issue mit dem Label `bug` |
| 10 | +2. **Feature vorschlagen:** Erstellen Sie ein Issue mit dem Label `enhancement` |
| 11 | +3. **Code beitragen:** Erstellen Sie einen Pull Request |
| 12 | + |
| 13 | +### Pull Requests |
| 14 | + |
| 15 | +1. Forken Sie das Repository |
| 16 | +2. Erstellen Sie einen Feature-Branch: `git checkout -b feature/mein-feature` |
| 17 | +3. Committen Sie Ihre Aenderungen: `git commit -m "Beschreibung der Aenderung"` |
| 18 | +4. Pushen Sie den Branch: `git push origin feature/mein-feature` |
| 19 | +5. Erstellen Sie einen Pull Request |
| 20 | + |
| 21 | +### Contributor License Agreement (CLA) |
| 22 | + |
| 23 | +<!-- OPTION A: Fuer Projekte mit Dual-Licensing (RPX, etc.) -- diesen Block verwenden --> |
| 24 | +Dieses Projekt verwendet ein [Contributor License Agreement (CLA)](CLA.md). |
| 25 | +Bei Ihrem ersten Pull Request bestaetigen Sie bitte Ihre Zustimmung durch einen Kommentar: |
| 26 | + |
| 27 | +> I have read and agree to the Contributor License Agreement (CLA). |
| 28 | +
|
| 29 | +Sie behalten Ihr Urheberrecht -- das CLA raeumt dem Projektinhaber lediglich Nutzungsrechte ein, die eine flexible Lizenzierung des Gesamtprojekts ermoeglichen. |
| 30 | + |
| 31 | +<!-- OPTION B: Fuer Community-Projekte ohne kommerzielle Plaene -- diesen Block stattdessen verwenden |
| 32 | +### Developer Certificate of Origin (DCO) |
| 33 | +
|
| 34 | +Dieses Projekt verwendet den [Developer Certificate of Origin (DCO)](https://developercertificate.org/). |
| 35 | +Bitte signieren Sie jeden Commit mit `--signoff`: |
| 36 | +
|
| 37 | + git commit --signoff -m "Beschreibung der Aenderung" |
| 38 | +
|
| 39 | +Damit bestaetigen Sie, dass Sie das Recht haben, den Code unter der Projektlizenz einzureichen. |
| 40 | +--> |
| 41 | + |
| 42 | +### Code-Richtlinien |
| 43 | + |
| 44 | +- Python: PEP 8 Stil |
| 45 | +- Encoding: UTF-8 fuer alle Dateien |
| 46 | +- Sprache: Code und Kommentare auf Deutsch oder Englisch |
| 47 | +- Keine hardcoded Pfade oder API-Keys |
| 48 | + |
| 49 | +### Erste Schritte |
| 50 | + |
| 51 | +```bash |
| 52 | +git clone https://github.com/lukisch/REL_Editor_PythonBox.git |
| 53 | +cd REL_Editor_PythonBox |
| 54 | +pip install -r requirements.txt |
| 55 | +python main.py |
| 56 | +``` |
| 57 | + |
| 58 | +--- |
| 59 | + |
| 60 | +## English |
| 61 | + |
| 62 | +Thank you for your interest in contributing to this project! |
| 63 | + |
| 64 | +### How to Contribute |
| 65 | + |
| 66 | +1. **Report bugs:** Create an issue with the `bug` label |
| 67 | +2. **Suggest features:** Create an issue with the `enhancement` label |
| 68 | +3. **Contribute code:** Create a Pull Request |
| 69 | + |
| 70 | +### Pull Requests |
| 71 | + |
| 72 | +1. Fork the repository |
| 73 | +2. Create a feature branch: `git checkout -b feature/my-feature` |
| 74 | +3. Commit your changes: `git commit -m "Description of change"` |
| 75 | +4. Push the branch: `git push origin feature/my-feature` |
| 76 | +5. Create a Pull Request |
| 77 | + |
| 78 | +### Contributor License Agreement (CLA) |
| 79 | + |
| 80 | +<!-- OPTION A: For projects with dual licensing (RPX, etc.) --> |
| 81 | +This project uses a [Contributor License Agreement (CLA)](CLA.md). |
| 82 | +On your first pull request, please confirm your agreement by commenting: |
| 83 | + |
| 84 | +> I have read and agree to the Contributor License Agreement (CLA). |
| 85 | +
|
| 86 | +You retain your copyright -- the CLA only grants the project owner usage rights that enable flexible licensing of the overall project. |
| 87 | + |
| 88 | +<!-- OPTION B: For community projects without commercial plans |
| 89 | +### Developer Certificate of Origin (DCO) |
| 90 | +
|
| 91 | +This project uses the [Developer Certificate of Origin (DCO)](https://developercertificate.org/). |
| 92 | +Please sign off every commit with `--signoff`: |
| 93 | +
|
| 94 | + git commit --signoff -m "Description of change" |
| 95 | +
|
| 96 | +This certifies that you have the right to submit the code under the project license. |
| 97 | +--> |
| 98 | + |
| 99 | +### Code Guidelines |
| 100 | + |
| 101 | +- Python: PEP 8 style |
| 102 | +- Encoding: UTF-8 for all files |
| 103 | +- Language: Code and comments in German or English |
| 104 | +- No hardcoded paths or API keys |
| 105 | + |
| 106 | +### Getting Started |
| 107 | + |
| 108 | +```bash |
| 109 | +git clone https://github.com/lukisch/REL_Editor_PythonBox.git |
| 110 | +cd REL_Editor_PythonBox |
| 111 | +pip install -r requirements.txt |
| 112 | +python main.py |
| 113 | +``` |
0 commit comments