kjodle/Apollo-11
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
9ec69ad78f
Apollo-11/CONTRIBUTING.md
Chris Garry 9ec69ad78f Move scan links closer to top for impatient readers (#372) 
* Move scan links closer to top for impatient readers

The links to the scans are included as a simple a "note" at the bottom of the README, when they should be at the top.

* fix discrepancies typo

* fix discrepancies typo x2
2019-01-28 04:35:40 +00:00

2.6 KiB
Raw Blame History

Contributing

🎌 English, 한국어

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 scanned printouts:

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:

Formatting

Note: GitHub and the 3 extensions listed 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, including:

Comments

  • Comments in the transcribed code should match the scans exactly
    • This could involve creating a deliberate typo or removing/adding an entire comment.

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

For example the following:

R0819   SUBROUTINE TO SKIP...
R0820



 0821   LAMPTEST  CS  IMODES33

Should become:

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!