Co-authored-by: James Harris <wopian@wopian.me>
4.7 KiB
Contributing
🎌 Čeština Deutsch, English, Español, Français, Kurdi, Nederlands, Português, Türkçe, العربية, Ελληνικά, 日本語, 正體中文, 简体中文, 한국어
Zdrojové kódy v tomto repozitáři byly manuálně digitalizovány z papírových zdrojových materiálů, mohou se v nich tedy vyskytovat chyby a překlepy. Kód by měl být modifikován tak, aby byl konzistentní se zdrojovým skenem:
Užitečná rozšíření
GitHub podporuje syntaxi AGC assembly jazyka. Váš editor pravděpodobně podporu mít nebude, proto zde poskytujeme seznam rozšíření na zvýraznění syntaxe jazyka AGC pro následující editory:
- Atom†
- CodeBlocks
- Eclipse
- Kate
- ProgrammersNotepad
- Sublime Text 3†
- TextPad
- Vim
- Visual Studio Code†
- jEdit
† Podporuje automatické formátování
Formátování
Poznámka: GitHub a výše uvedená rozšíření zajistí automatické použití správného formátování.
- Odsazení s použitím tabů
- Šířka tabu je 8
- Nezanechávat bílé znaky (whitespace) na konci řádků
Co mám kontrolovat?
Jakékoliv rozdíly mezi skeny a zdrojovým kódem v tomto repozitáři, včetně:
Komentářů
- Komentáře v přepsaném kódu by měly přesně odpovídat skenům
- Toto může zahrnovat doslovné kopírování překlepů či přidávání/odebírání celých komentářů
Zalomení řádků
- Zalomení řádků obsahujících
R0000
ve sloupci 1 by měly přesně odpovídat skenům. - Zalomení řádků bez
R0000
ve sloupci 1 by měly obsahovat jen 1 až 2 prázdné řádky v řadě- Pokud obsahují více než dva prázdné řádky, přebytečné odstraňte.
- Řádky obsahující
R0000
v prvním sloupci se do tohoto nepočítají.
- Řádky obsahující
- Vznikly díky nevytištěnému číslu ve sloupci 8 zdrojových dokumentů. Číslo 2 způsobilo vypsání dvojité mezery (jeden prázdný řádek) a číslo 3 trojité mezery (dva prázdné řádky). Hodnoty 4-8 byly definovány, ale nebyly použity. Více v #159
- Pokud obsahují více než dva prázdné řádky, přebytečné odstraňte.
Napříkald následující kód:
R0819 SUBROUTINE TO SKIP...
R0820
0821 LAMPTEST CS IMODES33
By měl být změněn na:
R0819 SUBROUTINE TO SKIP...
R0820
0820 LAMPTEST CS IMODES33
Mezery
- Mezery mezi dvěma znaky v řetězci by měly respektovat tyto konvence (viz diskuze v #316):
- Jedna mezera pro nová slova.
- Dvě mezery pro nové věty.
- Tři mezery pro odsazení.
Napříkald následující kód:
1) FOO BAR BAZ QUX QUUX QUUZ. CORGE, GRAULT,
GARPLY, WALDO.
By měl být změněn na:
1) FOO BAR BAZ QUX QUUX QUUZ. CORGE, GRAULT,
GARPLY, WALDO.
Poznámka
Než otevřete PR, ujistěte se že vaše změny jsou konzistentní se skeny!