Skip to content

Commit 5d5a240

Browse files
committed
CONSTRIBUTING.md -> wording improved
1 parent ddc5148 commit 5d5a240

1 file changed

Lines changed: 16 additions & 14 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -75,25 +75,25 @@ Das Skript ruft `msgfmt` auf, du brauchst also **gettext**:
7575

7676
### 1. Fork und Branch
7777

78+
Auf GitHub oben rechts **Fork**, dann im Terminal:
79+
7880
```
7981
git clone https://github.com/<dein-konto>/python-docs-de.git
8082
cd python-docs-de
8183
git checkout 3.15
8284
git checkout -b uebersetzung-pathlib
8385
```
8486

85-
### 2. Übersetzen
86-
87-
Empfohlen ist **[Poedit](https://poedit.net/)**. Es zeigt `msgid` und
88-
`msgstr` nebeneinander, kennt die PO-Syntax und bricht Zeilen korrekt um.
89-
90-
Zwei Dinge, die jeder Editor richtig machen muss:
87+
Alle weiteren Befehle in dieser Datei laufen in diesem Verzeichnis, also im
88+
Wurzelverzeichnis des Repositorys.
9189

92-
- Genau **ein** Kopfblock (`msgid ""`) pro Datei, mit `charset=UTF-8`.
93-
- Keine zusätzlichen Kopfblöcke am Dateiende. Das PyCharm-Gettext-Plugin
94-
hängt gelegentlich welche an.
90+
Für eine kleine Korrektur, kann direkt die Datei auf GitHub geöffnen werden,
91+
Stift-Symbol -> ändern -> Pull Request.
92+
Die Prüfungen laufen dann in der CI. Für eine ganze Datei ist der
93+
Browser-Editor nicht geeignet, dafür fehlt ihm die PO-Unterstützung.
94+
Empfohlen ist z.B. **[Poedit](https://poedit.net/)**.
9595

96-
### 3. Prüfen
96+
### 2. Prüfen
9797

9898
```
9999
./_tools/pre_push_check.sh --quick
@@ -113,11 +113,13 @@ Erst wenn das durchläuft, lohnt der Pull Request. `--full` hängt zusätzlich
113113
einen echten Sphinx-Build an (10–20 Minuten) – nötig nur bei größeren
114114
Änderungen.
115115

116-
Voraussetzung: `gettext` (für `msgfmt`) und `sphinx-lint`.
116+
Voraussetzung neben gettext: `pip install sphinx-lint`. Sobald du in deinen
117+
Fork pushst, laufen Syntax- und Lint-Prüfung außerdem automatisch als
118+
GitHub Action.
117119

118-
### 4. Pull Request
120+
### 3. Pull Request
119121

120-
Gegen `python/python-docs-de`, Branch `3.15`. Eine Datei oder ein Thema
122+
Gegen `python/python-docs-de`, akuteller Branch `3.15`. Eine Datei oder ein Thema
121123
pro Pull Request. In der Beschreibung das zugehörige Issue verlinken.
122124

123125
---
@@ -170,7 +172,7 @@ Zwei Grenzen:
170172

171173
- Maschinell übersetzte Dateien ohne eigene Durchsicht werden nicht
172174
übernommen.
173-
- Das `msgid` wird nie verändert, auch nicht in Kleinigkeiten.
175+
- Das `msgid` wird nie verändert.
174176

175177
---
176178

0 commit comments

Comments
 (0)