Skip to content

Latest commit

 

History

History
63 lines (51 loc) · 1.9 KB

CONTRIBUTING.md

File metadata and controls

63 lines (51 loc) · 1.9 KB

Contributing

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?

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