diff --git a/CONTRIBUTING.de.md b/CONTRIBUTING.de.md index eec3900..0847474 100644 --- a/CONTRIBUTING.de.md +++ b/CONTRIBUTING.de.md @@ -43,14 +43,14 @@ [ZH_CN]:CONTRIBUTING.zh_cn.md [ZH_TW]:CONTRIBUTING.zh_tw.md -Der Quellcode in diesem Repository wurde manuell digitalisiert, also sind jegliche schriftlichen Fehler und Ungereimtheiten aus Versehen hinzugefügt worden. Der Code soll so modifiziert werden, dass er mit den Vorlagen übereinstimmt. +Der Quellcode in diesem Repository wurde manuell digitalisiert, also sind jegliche Tippfehler und Diskrepanzen unabsichtlich eingeführt worden. Der Code soll so angepasst werden, dass er mit den folgenden eingescannten Ausdrucken übereinstimmt: - [AGC printouts for Comanche][8] - [AGC printouts for Luminary][9] ## Nützliche Erweiterungen -GitHub hat eine integrierte Unterstützung für AGC assembly. Das gilt leider nicht für deinen Editor. Für die folgenden Editoren gibt es aber AGC-Erweiterungen, die Syntaxhighlighting hinzufügen: +GitHub verfügt über eine integrierte Syntax-Unterstützung für die AGC Assembly Sprache. Das gilt leider nicht für deinen Code Editor. Für die folgenden Editoren gibt es aber AGC-Spracherweiterungen, die Syntaxhervorhebung hinzufügen: - [Atom][Atom]† - [CodeBlocks][CodeBlocks] @@ -63,7 +63,7 @@ GitHub hat eine integrierte Unterstützung für AGC assembly. Das gilt leider ni - [Visual Studio Code][VisualStudioCode]† - [jEdit][jEdit] -† unterstützt auch automatisches Formatieren +† Unterstützt automatische Formatierung [Atom]:https://github.com/Alhadis/language-agc [CodeBlocks]:https://github.com/virtualagc/virtualagc/tree/master/Contributed/SyntaxHighlight/CodeBlocks @@ -80,28 +80,47 @@ GitHub hat eine integrierte Unterstützung für AGC assembly. Das gilt leider ni **Anmerkung:** GitHub und die oben erwähnten Erweiterungen werden automatisch sicherstellen, dass du die korrekte Formatierung einhältst. -- benutze tab indentation -- benutze tab width von 8 -- entferne Leerzeichen am Ende einer Zeile +- Verwende Tab-Einrückung +- Verwende Tab-Breite von 8 +- Entferne Leerzeichen am Ende einer Zeile ## Was soll ich überprüfen? -Alle Ungereimtheiten zwischen den Scans und dem Code in diesem Repository, einschließlich: +Alle Diskrepanzen zwischen den Scans und dem Quelltext in diesem Repository. ### Kommentare -- Kommentare in dem abgeschriebenen Code müssen denen in den Scans gleichen - - Das kann bedeuten, dass man einen Rechtschreibfehler übernehmen oder einen ganzen Kommentar entfernen/hinzufügen muss +Kommentare in dem transkribierten Quellcode **MÜSSEN** denen in den Scans **genau** entsprechen. -### Zeilenumbruch +Häufige Fehler, auf die du dich unter anderem beim Korrekturlesen achten solltest sind folgende (nicht abschließend): -- Zeilenumbrüche *mit* `R0000` in Spalte 1 sollte genau mit den Scans übereinstimmen -- Zeilenumbrüche *__ohne__* `R0000` in Spalte 1 sollten nur ein bis zwei Leerzeilen nacheinander haben - - Wenn es dort mehr als zwei Leerzeilen gibt, sollten die zusätzlichen Leerzeilen entfernt werden. - - Zeilen mit `R0000` in Spalte 1 zählen nicht dazu - - In den Originalbildern wurden die durch eine nicht gedruckte Ziffer in Spalte 8 verursacht. Eine 2 dort hat ein doppeltes Leerzeichen (einzelne Leerzeile) und eine 3 hat ein dreifaches Leerzeichen (doppelte Leerzeile). Die Werte 4-8 wurden definiert, aber nie benutzt. Mehr dazu hier: [#159][7] +#### Typographische Fehler -Beispiel: +An einigen Stellen haben die ursprünglichen Entwickler typographische Fehler beim Schreiben von Kommentaren gemacht. Manche von diesen wurden fälschlicherweise bei der ursprünglichen Digitalisierung korrigiert, die Digitalisierung hat jedoch auch typografische Fehler eingeführt die nicht in den Scans vorhanden sind. + +Wenn die digitalisierten Kommentare zum Beispiel `SPACECRAFT` enthielten aber `SPAECRAFT` in den Scans stand, dann **MUSS** die Digitalisierung zu `SPAECRAFT` korrigiert werden (fehlendes `C`). + +Gleichermaßen gilt, dass wenn ein Wort einen Tippfehler in der Digitalisierung aufweist aber in den Scans korrekt geschrieben wurde der Tippfehler korrigiert werden **MUSS**. + +#### Leerzeichen + +Leerzeichen zwischen zwei Zeichen in Kommentaren **SOLLTEN** den Scans angeglichen werden. In den meisten Fällen (siehe die Diskussion in [#316][10]) sind es: + +- Einzelne Leerzeichen für neue Wörter. +- Doppelte Leerzeichen für neue Sätze. +- Dreifache Leerzeichen für Einrückungen. + +Nicht alle Seiten in den Scans befolgen diese Verallgemeinerung, wenn es in den Scans nur ein einzelnes Leerzeichen gibt statt einem doppelten Leerzeichen, verwende ein einzelnes Leerzeichen. + +### Zeilenumbrüche + +- Zeilenumbrüche *mit* `R0000` in Spalte 1 sollten genau mit den Scans übereinstimmen +- Zeilenumbrüche *__ohne__* `R0000` in Spalte 1 sollten nur 1 bis 2 Leerzeilen hintereinander haben + - Wenn es mehr als 2 Leerzeilen gibt, entferne die zusätzlichen Zeilenumbrüche. + - Zeilen mit `R0000` in Spalte 1 werden dabei nicht dazugezählt. + - In den Originalbildern wurden diese durch eine nicht gedruckte Ziffer in Spalte 8 verursacht. Eine 2 an dieser Stelle erzwang ein doppeltes Leerzeichen (einzelne Leerzeile) und eine 3 erzwang ein dreifaches Leerzeichen (doppelte Leerzeile). Die Werte zwischen 4 und 8 waren definiert, wurden aber nie verwendet. Mehr dazu in [#159][7] + +Zum Beispiel, das folgende: ```plain R0819 SUBROUTINE TO SKIP... @@ -112,7 +131,7 @@ R0820 0821 LAMPTEST CS IMODES33 ``` -wird zu: +Sollte werden zu: ```plain R0819 SUBROUTINE TO SKIP... @@ -122,9 +141,9 @@ R0820 0820 LAMPTEST CS IMODES33 ``` -## Hinweis +## Anmerkung -Bevor du einen PR startest, überprüfe bitte, ob die Änderungen mit den Scans übereinstimmen! +Bevor du einen PR erstellst, stelle bitte sicher, dass deine Änderungen mit den Scans übereinstimmen! [0]:https://github.com/chrislgarry/Apollo-11/pull/new/master [1]:http://www.ibiblio.org/apollo/ScansForConversion/Luminary099/