Improve existing German READMEs and add new ones#3444
Improve existing German READMEs and add new ones#3444sieberss wants to merge 14 commits intoiluwatar:masterfrom
Conversation
PR SummaryLocalized German READMEs by refining translations and adding new ones. Reformulated existing German READMEs (Abstract Document, central README) and added new German READMEs for patterns like Abstract Factory, Active Object, Actor Model, and Acyclic Visitor. Included diagram assets (URM/png) to accompany the READMEs. Changes
autogenerated by presubmit.ai |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
✅ LGTM!
Review Summary
Commits Considered (3)
Files Processed (2)
- localization/de/README.md (2 hunks)
- localization/de/abstract-document/README.md (4 hunks)
Actionable Comments (0)
Skipped Comments (6)
-
localization/de/README.md [1-4]
readability: "Inconsistency in badge wording"
-
localization/de/README.md [14-15]
readability: "Language list and link consistency"
-
localization/de/README.md [19-24]
readability: "Intro copy consistency"
-
localization/de/README.md [37-37]
readability: "Terminology consistency"
-
localization/de/README.md [47-50]
readability: "Book section language and capitalization"
-
localization/de/README.md [54-54]
readability: "License phrasing"
There was a problem hiding this comment.
🚨 Pull request needs attention.
Review Summary
Commits Considered (1)
- 398d4f5: Create folder for Abstract Factory
Files Processed (3)
- localization/de/Abstract Factory (1 hunk)
- localization/de/README.md (2 hunks)
- localization/de/abstract-document/README.md (4 hunks)
Actionable Comments (1)
-
localization/de/abstract-document/README.md [88-92]
readability: "Narrative text inside code block breaks Java code snippet."
Skipped Comments (9)
-
localization/de/Abstract Factory [1-1]
maintainability: "Remove empty placeholder file or replace with a valid README."
-
localization/de/README.md [1-4]
readability: "Check German title and top-section localization."
-
localization/de/README.md [11-16]
readability: "Add language navigation links."
-
localization/de/README.md [37-37]
readability: "Verify list formatting and language consistency in new bullets."
-
localization/de/README.md [45-50]
readability: "Add book section; fix minor localization typos."
-
localization/de/README.md [54-54]
readability: "License phrasing"
-
localization/de/abstract-document/README.md [3-11]
readability: "Localize front-matter tags."
-
localization/de/abstract-document/README.md [238-245]
readability: "Clarify advantages/disadvantages section layout."
-
localization/de/abstract-document/README.md [246-249]
readability: "Remove/handle affiliate links in sources."
| // Weitere Eigenschaften und Methoden... | ||
| } | ||
| ``` | ||
| Als nächstes definieren wir ein Enum Property und eine Menge von Schnittstellen für Typ, Preis, Modell und Teile. Dies ermöglicht es uns, eine statisch aussehende Schnittstelle für unsere Car-Klasse zu erstellen. | ||
| Als nächstes definieren wir ein Enum `Property` und je eine Schnittstelle für Typ, Preis, Modell und Teile. So können wir eine statisch aussehende Schnittstelle für unsere Klasse `Car` erstellen. | ||
|
|
There was a problem hiding this comment.
Narrative explanations were inserted inside a Java code block, which will break syntax. Move these explanations outside the code block or convert to code comments.
There was a problem hiding this comment.
They are outside the code block
|
There was a problem hiding this comment.
✅ LGTM!
Review Summary
Commits Considered (1)
- e71866f: Create README.md for Abstract Document
Files Processed (1)
- localization/de/abstract-factory/README.md (1 hunk)
Actionable Comments (0)
Skipped Comments (8)
-
localization/de/abstract-factory/README.md [19-21]
readability: "Grammatik und Stil verbessern"
-
localization/de/abstract-factory/README.md [23-23]
readability: "Übersetzung von Überschriften"
-
localization/de/abstract-factory/README.md [25-29]
readability: "Bilingual content inconsistency"
-
localization/de/abstract-factory/README.md [31-31]
readability: "Übersetzung von Überschriften"
-
localization/de/abstract-factory/README.md [35-35]
readability: "Übersetzung von Überschriften"
-
localization/de/abstract-factory/README.md [39-39]
readability: "Übersetzung von Überschriften"
-
localization/de/abstract-factory/README.md [172-172]
readability: "Übersetzung von Überschriften"
-
localization/de/abstract-factory/README.md [190-190]
readability: "Übersetzung von Überschriften"
There was a problem hiding this comment.
🚨 Pull request needs attention.
Review Summary
Commits Considered (1)
- 624e970: Translate README.md for Abstract Document to German
Files Processed (1)
- localization/de/abstract-factory/README.md (1 hunk)
Actionable Comments (1)
-
localization/de/abstract-factory/README.md [36-36]
typo: "Typo: 'Klassse' → 'Klasse'"
Skipped Comments (4)
-
localization/de/abstract-factory/README.md [40-40]
readability: "Bildpfad fehlerhaft: UML-Diagramm-Datei"
-
localization/de/abstract-factory/README.md [90-90]
readability: "Markdown-Codeblock falsch beendet"
-
localization/de/abstract-factory/README.md [146-146]
readability: "Ungenauigkeit im Beispielpfad"
-
localization/de/abstract-factory/README.md [199-205]
readability: "Formatter-Fehler: leere Bulletzeilen"
|
|
||
| Wikipedia sagt | ||
|
|
||
| > Das Abstract-Factory-Pattern dient zur Kapselung einer Gruppe einzelner Factories mit gemeinsamem Thema, wobei deren konkrete Klassse variabel bleibt. |
There was a problem hiding this comment.
Typo in German translation: 'Klassse' ist falsch geschrieben. Korrigiere zu 'Klasse'.
There was a problem hiding this comment.
✅ LGTM!
Review Summary
Commits Considered (1)
- b91d1f7: correct typo
Files Processed (1)
- localization/de/abstract-factory/README.md (1 hunk)
Actionable Comments (0)
Skipped Comments (2)
-
localization/de/abstract-factory/README.md [89-89]
readability: "Inconsistent Orc/Ork terminology in sample code"
-
localization/de/abstract-factory/README.md [143-155]
readability: "Usage example has incorrect/type reference and naming"
There was a problem hiding this comment.
🚨 Pull request needs attention.
Review Summary
Commits Considered (10)
- a1c4254: docs: Create German README.md for Active Object
#2275
first text part
- b1061ff: docs: add missing words in abstract-factory.README.md
(#2275) - 908b93d: docs: add class diagrams for all patterns
(#2275) - b91d1f7: correct typo
- 624e970: Translate README.md for Abstract Document to German
- e71866f: Create README.md for Abstract Document
- 398d4f5: Create folder for Abstract Factory
- 325b272: docs: reformulate german translation for Abstract Document
(#2275) - ca43940: docs: shorten text for link to payhip
(#2275) - 5f9e2d2: docs: reformulate text, add links to further languages and paragraph about the book in central README.md
(#2275)
Files Processed (30)
- localization/de/Abstract Factory (1 hunk)
- localization/de/README.md (2 hunks)
- localization/de/abstract-document/README.md (4 hunks)
- localization/de/abstract-factory/README.md (1 hunk)
- localization/de/abstract-factory/etc/abstract-factory.urm.png (0 hunks)
- localization/de/active-object/README.md (1 hunk)
- localization/de/active-object/etc/active-object.urm.png (0 hunks)
- localization/de/adapter/etc/adapter.urm.png (0 hunks)
- localization/de/aggregator-microservices/aggregator-service/etc/aggregator-service.png (0 hunks)
- localization/de/ambassador/etc/ambassador.urm.png (0 hunks)
- localization/de/api-gateway/etc/api-gateway.png (0 hunks)
- localization/de/async-method-invocation/etc/async-method-invocation.png (0 hunks)
- localization/de/balking/etc/balking.png (0 hunks)
- localization/de/bridge/etc/bridge.urm.png (0 hunks)
- localization/de/builder/etc/builder.urm.png (0 hunks)
- localization/de/business-delegate/etc/business-delegate.urm.png (0 hunks)
- localization/de/bytecode/etc/bytecode.urm.png (0 hunks)
- localization/de/chain-of-responsibility/etc/chain-of-responsibility.urm.png (0 hunks)
- localization/de/client-session/etc/session_state_pattern.png (0 hunks)
- localization/de/collecting-parameter/etc/collecting-parameter.urm.png (0 hunks)
- localization/de/command/etc/command.png (0 hunks)
- localization/de/commander/etc/commander.urm.png (0 hunks)
- localization/de/composite-entity/etc/composite_entity.urm.png (0 hunks)
- localization/de/composite-view/etc/composite_view.png (0 hunks)
- localization/de/composite-view/etc/images/noparam.png (0 hunks)
- localization/de/composite-view/etc/images/threeparams.png (0 hunks)
- localization/de/composite/etc/composite.urm.png (0 hunks)
- localization/de/context-object/etc/context-object.png (0 hunks)
- localization/de/converter/etc/converter.png (0 hunks)
- localization/de/crtp/etc/crtp.png (0 hunks)
Actionable Comments (1)
-
localization/de/abstract-document/README.md [128-137]
best_practice: "Narrative inside code block"
Skipped Comments (7)
-
localization/de/Abstract Factory [1-1]
maintainability: "Invalid path due to spaces in directory name"
-
localization/de/README.md [1-1]
best_practice: "Front matter consistency"
-
localization/de/README.md [14-15]
readability: "Multilingual links formatting"
-
localization/de/README.md [19-27]
readability: "German introductory copy quality"
-
localization/de/README.md [37-37]
readability: "Terminology consistency (patterns category)"
-
localization/de/README.md [41-50]
readability: "German grammar and consistency in Mitarbeit section"
-
localization/de/abstract-document/README.md [1-16]
maintainability: "Front matter localization inconsistencies"
| Nun können wir das `Car` einführen. | ||
|
|
||
| ```java | ||
| public static void main(String[] args) { | ||
| LOGGER.info("Konstruktion von Teilen und Auto"); | ||
|
|
||
| var wheelProperties = Map.of( | ||
| Property.TYPE.toString(), "wheel", | ||
| Property.MODEL.toString(), "15C", | ||
| Property.PRICE.toString(), 100L); | ||
|
|
||
| var doorProperties = Map.of( | ||
| Property.TYPE.toString(), "door", | ||
| Property.MODEL.toString(), "Lambo", | ||
| Property.PRICE.toString(), 300L); | ||
|
|
||
| var carProperties = Map.of( | ||
| Property.MODEL.toString(), "300SL", | ||
| Property.PRICE.toString(), 10000L, | ||
| Property.PARTS.toString(), List.of(wheelProperties, doorProperties)); | ||
|
|
||
| var car = new Car(carProperties); | ||
|
|
||
| LOGGER.info("Hier ist unser Auto:"); | ||
| LOGGER.info("-> Modell: {}", car.getModel().orElseThrow()); | ||
| LOGGER.info("-> Preis: {}", car.getPrice().orElseThrow()); | ||
| LOGGER.info("-> Teile: "); | ||
| public class Car extends AbstractDocument implements HasModel, HasPrice, HasParts { | ||
|
|
||
| public Car(Map<String, Object> properties) { | ||
| super(properties); | ||
| } | ||
| } | ||
| ``` |
There was a problem hiding this comment.
The German instructional text between code blocks should be placed outside the Java code blocks. Narrative comments inside a code block can break compilation when copied as code; move non-code explanations to prose sections or convert to Java comments inside the code.
sieberss
changed the title
There was a problem hiding this comment.
🚨 Pull request needs attention.
Review Summary
Files Processed (1)
- localization/de/actor-model/README.md (1 hunk)
Actionable Comments (2)
-
localization/de/actor-model/README.md [35-35]
typo: "Typo in German translation"
-
localization/de/actor-model/README.md [175-175]
typo: "Typo in benefits section"
Skipped Comments (4)
-
localization/de/actor-model/README.md [107-110]
readability: "Language consistency in code sample"
-
localization/de/actor-model/README.md [113-113]
readability: "Inconsistent ID capitalization"
-
localization/de/actor-model/README.md [2-12]
maintainability: "Front matter translation consistency"
-
localization/de/actor-model/README.md [178-178]
readability: "Inconsistent terminology for 'actors' plural"
| Stellen Sie sich ein Kundendienstsystem vor. | ||
| - Jeder **Kundendienstmitarbeiter** ist ein **Aktor**. | ||
| - Kunden **senden Anfragen (Nachrichten)** an die Mitarbeiter. | ||
| - Jeder Mitarbeiter behandelt zu einem bestimmten Zeitpunkt genau eine Anfrage und kann diese **asychron beantworten**, |
There was a problem hiding this comment.
Typo detected: the German line uses the misspelling 'asychron'. It should be 'asynchron' (or 'asynchron').
| ## Vor- und Nachteile | ||
|
|
||
| ### ✅ Benefits | ||
| - Unterstützt hohes Maß an Parellelität |
There was a problem hiding this comment.
Typo: 'Parellelität' should be 'Parallelität'.
There was a problem hiding this comment.
✅ LGTM!
Review Summary
Commits Considered (14)
- 0fdb2f6: docs: translate actor-model into German
- 362646e: docs: finish German translation of README.md for Active Object
- a1c4254: docs: Create German README.md for Active Object
#2275
first text part
- b1061ff: docs: add missing words in abstract-factory.README.md
(#2275) - 908b93d: docs: add class diagrams for all patterns
(#2275) - b91d1f7: correct typo
- 624e970: Translate README.md for Abstract Document to German
- e71866f: Create README.md for Abstract Document
- 398d4f5: Create folder for Abstract Factory
- 325b272: docs: reformulate german translation for Abstract Document
(#2275) - ca43940: docs: shorten text for link to payhip
(#2275) - 5f9e2d2: docs: reformulate text, add links to further languages and paragraph about the book in central README.md
(#2275)
Files Processed (30)
- localization/de/Abstract Factory (1 hunk)
- localization/de/README.md (2 hunks)
- localization/de/abstract-document/README.md (4 hunks)
- localization/de/abstract-factory/README.md (1 hunk)
- localization/de/abstract-factory/etc/abstract-factory.urm.png (0 hunks)
- localization/de/active-object/README.md (1 hunk)
- localization/de/active-object/etc/active-object.urm.png (0 hunks)
- localization/de/actor-model/README.md (1 hunk)
- localization/de/acyclic-visitor/README.md (1 hunk)
- localization/de/adapter/etc/adapter.urm.png (0 hunks)
- localization/de/aggregator-microservices/aggregator-service/etc/aggregator-service.png (0 hunks)
- localization/de/ambassador/etc/ambassador.urm.png (0 hunks)
- localization/de/api-gateway/etc/api-gateway.png (0 hunks)
- localization/de/async-method-invocation/etc/async-method-invocation.png (0 hunks)
- localization/de/balking/etc/balking.png (0 hunks)
- localization/de/bridge/etc/bridge.urm.png (0 hunks)
- localization/de/builder/etc/builder.urm.png (0 hunks)
- localization/de/business-delegate/etc/business-delegate.urm.png (0 hunks)
- localization/de/bytecode/etc/bytecode.urm.png (0 hunks)
- localization/de/chain-of-responsibility/etc/chain-of-responsibility.urm.png (0 hunks)
- localization/de/client-session/etc/session_state_pattern.png (0 hunks)
- localization/de/collecting-parameter/etc/collecting-parameter.urm.png (0 hunks)
- localization/de/command/etc/command.png (0 hunks)
- localization/de/commander/etc/commander.urm.png (0 hunks)
- localization/de/composite-entity/etc/composite_entity.urm.png (0 hunks)
- localization/de/composite-view/etc/composite_view.png (0 hunks)
- localization/de/composite-view/etc/images/noparam.png (0 hunks)
- localization/de/composite-view/etc/images/threeparams.png (0 hunks)
- localization/de/composite/etc/composite.urm.png (0 hunks)
- localization/de/context-object/etc/context-object.png (0 hunks)
Actionable Comments (0)
Skipped Comments (3)
-
localization/de/Abstract Factory [1-1]
maintainability: "Remove empty placeholder file or add content"
-
localization/de/README.md [1-4]
readability: "German root README header update"
-
localization/de/abstract-document/README.md [14-16]
readability: "Add/verify Zweck section in Abstract Document README"
|
1 participant
Issue #2275
What does this PR do?