|
2 | 2 |
|
3 | 3 | ## Deutsch |
4 | 4 |
|
5 | | -Vielen Dank fuer Ihr Interesse, zu diesem Projekt beizutragen! |
| 5 | +Vielen Dank für Ihr Interesse an PythonBox. |
6 | 6 |
|
7 | | -### Wie Sie beitragen koennen |
| 7 | +### Beiträge |
8 | 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 |
| 9 | +1. Bugs als GitHub Issue mit reproduzierbaren Schritten melden. |
| 10 | +2. Feature-Vorschläge als Issue mit erwarteter Nutzung beschreiben. |
| 11 | +3. Codeänderungen über Pull Requests einreichen. |
12 | 12 |
|
13 | 13 | ### Pull Requests |
14 | 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 |
| 15 | +1. Repository forken. |
| 16 | +2. Feature-Branch erstellen: `git checkout -b feature/mein-feature` |
| 17 | +3. Änderungen lokal testen. |
| 18 | +4. Commit erstellen: `git commit -m "Beschreibung der Änderung"` |
| 19 | +5. Branch pushen und Pull Request öffnen. |
20 | 20 |
|
21 | | -### Contributor License Agreement (CLA) |
| 21 | +### Lokaler Start |
22 | 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 | | ---> |
| 23 | +```bash |
| 24 | +git clone https://github.com/dev-bricks/pythonbox.git |
| 25 | +cd pythonbox |
| 26 | +pip install -r requirements.txt |
| 27 | +python PythonBox_v8.py |
| 28 | +``` |
41 | 29 |
|
42 | 30 | ### Code-Richtlinien |
43 | 31 |
|
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 |
| 32 | +- Python-Code folgt PEP 8. |
| 33 | +- GUI-Code nutzt PySide6. |
| 34 | +- Dokumente und Quelltexte werden als UTF-8 gespeichert. |
| 35 | +- Keine hardcodierten privaten Pfade, Tokens, Passwörter oder API-Keys. |
| 36 | +- Interne Dateien wie `AUFGABEN.txt`, Test-Locks, Build-Artefakte und lokale Releases bleiben unversioniert. |
| 37 | +- Dokumentation aktualisieren, wenn sich Bedienung, Installation oder Build-Prozess ändern. |
48 | 38 |
|
49 | | -### Erste Schritte |
| 39 | +### Lizenz |
50 | 40 |
|
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 | | -``` |
| 41 | +Mit dem Einreichen eines Pull Requests bestätigen Sie, dass Sie die Rechte an Ihrem Beitrag besitzen und ihn unter der MIT-Lizenz dieses Projekts bereitstellen können. |
57 | 42 |
|
58 | 43 | --- |
59 | 44 |
|
60 | 45 | ## English |
61 | 46 |
|
62 | | -Thank you for your interest in contributing to this project! |
| 47 | +Thank you for your interest in PythonBox. |
63 | 48 |
|
64 | | -### How to Contribute |
| 49 | +### Contributions |
65 | 50 |
|
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 |
| 51 | +1. Report bugs as GitHub issues with reproducible steps. |
| 52 | +2. Describe feature requests as issues with the expected workflow. |
| 53 | +3. Submit code changes through pull requests. |
69 | 54 |
|
70 | 55 | ### Pull Requests |
71 | 56 |
|
72 | | -1. Fork the repository |
| 57 | +1. Fork the repository. |
73 | 58 | 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 |
| 59 | +3. Test the changes locally. |
| 60 | +4. Commit: `git commit -m "Description of change"` |
| 61 | +5. Push the branch and open a pull request. |
77 | 62 |
|
78 | | -### Contributor License Agreement (CLA) |
| 63 | +### Local Setup |
79 | 64 |
|
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 | | ---> |
| 65 | +```bash |
| 66 | +git clone https://github.com/dev-bricks/pythonbox.git |
| 67 | +cd pythonbox |
| 68 | +pip install -r requirements.txt |
| 69 | +python PythonBox_v8.py |
| 70 | +``` |
98 | 71 |
|
99 | 72 | ### Code Guidelines |
100 | 73 |
|
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 |
| 74 | +- Follow PEP 8 for Python code. |
| 75 | +- Use PySide6 for GUI code. |
| 76 | +- Store documents and source files as UTF-8. |
| 77 | +- Do not commit private paths, tokens, passwords, or API keys. |
| 78 | +- Keep internal task files, test locks, build artifacts, and local releases out of Git. |
| 79 | +- Update documentation when usage, installation, or build behavior changes. |
105 | 80 |
|
106 | | -### Getting Started |
| 81 | +### License |
107 | 82 |
|
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 | | -``` |
| 83 | +By submitting a pull request, you confirm that you have the rights to your contribution and can provide it under this project's MIT license. |
0 commit comments