158 lines
5.3 KiB
Markdown
158 lines
5.3 KiB
Markdown
# Contributing
|
|
|
|
🎌
|
|
[Čeština][CZ],
|
|
[Dansk][DA],
|
|
[Deutsch][DE],
|
|
**English**,
|
|
[Español][ES],
|
|
[Français][FR],
|
|
[Italiano][IT],
|
|
[Kurdi][KU],
|
|
[Lietuvių][LT],
|
|
[Nederlands][NL],
|
|
[Norsk][NO],
|
|
[Polski][PL],
|
|
[Português][PT_BR],
|
|
[Türkçe][TR],
|
|
[Ukrainian][UA]،
|
|
[Ελληνικά][GR],
|
|
[العربية][AR],
|
|
[日本語][JA],
|
|
[正體中文][ZH_TW],
|
|
[简体中文][ZH_CN],
|
|
[한국어][KO_KR]
|
|
|
|
[AR]:CONTRIBUTING.ar.md
|
|
[CZ]:CONTRIBUTING.cz.md
|
|
[DA]:CONTRIBUTING.da.md
|
|
[DE]:CONTRIBUTING.de.md
|
|
[EN]:CONTRIBUTING.md
|
|
[ES]:CONTRIBUTING.es.md
|
|
[FR]:CONTRIBUTING.fr.md
|
|
[GR]:CONTRIBUTING.gr.md
|
|
[IT]:CONTRIBUTING.it.md
|
|
[JA]:CONTRIBUTING.ja.md
|
|
[KO_KR]:CONTRIBUTING.ko_kr.md
|
|
[KU]:CONTRIBUTING.ku.md
|
|
[LT]:CONTRIBUTING.lt.md
|
|
[NL]:CONTRIBUTING.nl.md
|
|
[NO]:CONTRIBUTING.no.md
|
|
[PL]:CONTRIBUTING.pl.md
|
|
[PT_BR]:CONTRIBUTING.pt_br.md
|
|
[TR]:CONTRIBUTING.tr.md
|
|
[UA]:CONTRIBUTING.ua.md
|
|
[ZH_CN]:CONTRIBUTING.zh_cn.md
|
|
[ZH_TW]:CONTRIBUTING.zh_tw.md
|
|
|
|
The source code in this repository was digitized manually from paper printouts, so typos and other discrepancies have been introduced accidentally. The code shall be modified to be made consistent with the following scanned printouts:
|
|
|
|
- [AGC printouts for Comanche][8]
|
|
- [AGC printouts for Luminary][9]
|
|
|
|
## Useful Extensions
|
|
|
|
GitHub has syntax support for the AGC assembly language built-in. Unfortunately your code editor will not, however there are AGC language extensions that provides syntax highlighting for the following editors:
|
|
|
|
- [Atom][Atom]†
|
|
- [CodeBlocks][CodeBlocks]
|
|
- [Eclipse][Eclipse]
|
|
- [Kate][Kate]
|
|
- [ProgrammersNotepad][ProgrammersNotepad]
|
|
- [Sublime Text 3][Sublime Text]†
|
|
- [TextPad][TextPad]
|
|
- [Vim][Vim]
|
|
- [Visual Studio Code][VisualStudioCode]†
|
|
- [jEdit][jEdit]
|
|
|
|
† Supports automatic formatting
|
|
|
|
[Atom]:https://github.com/Alhadis/language-agc
|
|
[CodeBlocks]:https://github.com/virtualagc/virtualagc/tree/master/Contributed/SyntaxHighlight/CodeBlocks
|
|
[Eclipse]:https://github.com/virtualagc/virtualagc/tree/master/Contributed/SyntaxHighlight/Eclipse
|
|
[Kate]:https://github.com/virtualagc/virtualagc/tree/master/Contributed/SyntaxHighlight/Kate
|
|
[ProgrammersNotepad]:https://github.com/virtualagc/virtualagc/tree/master/Contributed/SyntaxHighlight/ProgrammersNotepad
|
|
[Sublime Text]:https://github.com/jimlawton/AGC-Assembly
|
|
[TextPad]:https://github.com/virtualagc/virtualagc/tree/master/Contributed/SyntaxHighlight/TextPad
|
|
[Vim]:https://github.com/wsdjeg/vim-assembly
|
|
[VisualStudioCode]:https://github.com/wopian/agc-assembly
|
|
[jEdit]:https://github.com/virtualagc/virtualagc/tree/master/Contributed/SyntaxHighlight/jEdit
|
|
|
|
## Formatting
|
|
|
|
**Note:** GitHub and extensions marked above will ensure you're using the correct formatting automatically.
|
|
|
|
- Use tab indentation
|
|
- Use tab width of 8
|
|
- Trim trailing whitespace
|
|
|
|
## What do I check?
|
|
|
|
Any discrepancies between the scans and the source code in this repository.
|
|
|
|
### Comments
|
|
|
|
Comments in the transcribed code **MUST** match the scans **exactly**.
|
|
|
|
Common issues you should look out for while proofing include, but not limited to:
|
|
|
|
#### Typographic Errors
|
|
|
|
In some places, the original developers made typographic errors while writing comments. Some of these were mistakenly corrected during the initial digitisation, however the digitisation has also introduced typographic errors that were not present in the scans.
|
|
|
|
For example, if the digitised comments contained `SPACECRAFT`, but `SPAECRAFT` was printed in the scans, then the digitisation **MUST** be corrected to `SPAECRAFT` (missing `C`).
|
|
|
|
Likewise, if a word has a typo in the digitisation but is spelt correctly in the scans then the typo **MUST** be corrected.
|
|
|
|
#### Spaces
|
|
|
|
Spaces between two characters in comments **SHOULD** match the scans. In most cases (see the discussion in [#316][10]), this is:
|
|
|
|
- Single space for new words.
|
|
- Double space for new sentences.
|
|
- Triple space for indentations.
|
|
|
|
Not all pages in the scans follow this generalisation, if the scans only have a single space instead of a double space, use a single space.
|
|
|
|
### Line breaks
|
|
|
|
- Line breaks *with* `R0000` in column 1 should match the scans exactly.
|
|
- Line breaks *with**__out__* `R0000` in column 1 should contain only 1 or 2 blank lines in a row.
|
|
- If there are more than 2 blank lines breaks, strip the extra line breaks.
|
|
- Lines with `R0000` in column 1 do not count towards this.
|
|
- In the source images, these were created by an unprinted digit in column 8. A 2 there forced a double space (single blank line) and a 3 forced a triple space (double blank line). Values 4-8 were defined but never used. Read more about it in [#159][7]
|
|
|
|
For example the following:
|
|
|
|
```plain
|
|
R0819 SUBROUTINE TO SKIP...
|
|
R0820
|
|
|
|
|
|
|
|
0821 LAMPTEST CS IMODES33
|
|
```
|
|
|
|
Should become:
|
|
|
|
```plain
|
|
R0819 SUBROUTINE TO SKIP...
|
|
R0820
|
|
|
|
|
|
0820 LAMPTEST CS IMODES33
|
|
```
|
|
|
|
## Note
|
|
|
|
Before you make a PR, please make sure your changes are consistent with the scans!
|
|
|
|
[0]:https://github.com/chrislgarry/Apollo-11/pull/new/master
|
|
[1]:http://www.ibiblio.org/apollo/ScansForConversion/Luminary099/
|
|
[2]:http://www.ibiblio.org/apollo/ScansForConversion/Comanche055/
|
|
[6]:https://github.com/wopian/agc-assembly#user-settings
|
|
[7]:https://github.com/chrislgarry/Apollo-11/issues/159
|
|
[8]:http://www.ibiblio.org/apollo/ScansForConversion/Comanche055/
|
|
[9]:http://www.ibiblio.org/apollo/ScansForConversion/Luminary099/
|
|
[10]:https://github.com/chrislgarry/Apollo-11/pull/316#pullrequestreview-102892741
|