Apollo-11/CONTRIBUTING.md

66 lines
2.0 KiB
Markdown
Raw Normal View History

2017-02-13 23:56:53 +00:00
# Contributing
2017-02-14 00:10:18 +00:00
## What do I check?
2017-02-13 23:56:53 +00:00
### Comments
2017-02-22 04:55:56 +00:00
- Comments in the transcribed code should match the scans exactly
2017-02-13 23:56:53 +00:00
- This could involve creating a deliberate typo or removing/adding
an entire comment.
### Line breaks
2017-02-22 04:55:56 +00:00
- Line breaks *with* `R0000` in column 1 should match the scans exactly.
- Line breaks *with**__out__* `R0000` in column 1 should contain only 1
2017-02-14 00:10:18 +00:00
or 2 blank lines in a row.
2017-02-14 00:07:17 +00:00
- If there are more than 2 blank lines breaks, strip the extra
2017-02-13 23:56:53 +00:00
line breaks.
2017-02-22 04:55:56 +00:00
- Lines with `R0000` in column 1 do not count towards this.
2017-02-13 23:56:53 +00:00
- 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
2017-02-14 11:58:40 +00:00
defined but never used. Read more about it in [#159][7]
2017-02-22 04:55:56 +00:00
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
```
2017-02-13 23:56:53 +00:00
## Formatting
**Note:** GitHub, [AGC Assembly][3] for Visual Studio Code,
[AGC Assembly][4] for Sublime Text 3 and [Language AGC][5]
2017-02-14 00:10:18 +00:00
for Atom will ensure you're using the correct formatting
automatically.
2017-02-14 00:07:17 +00:00
2017-02-13 23:56:53 +00:00
- Use tab indentation
- Use tab width of 8
- Trim trailing whitespace
## Useful Extensions
GitHub has syntax support for the AGC assembly language built-in.
2017-02-22 04:55:56 +00:00
Unfortunately your code editor will not, however there are
AGC language extensions that provides syntax highlighting for the
following editors:
2017-02-13 23:56:53 +00:00
- [Atom][5]
2017-02-22 04:55:56 +00:00
- [Sublime Text 3][4]
- [Visual Studio Code][3]
2017-02-13 23:56:53 +00:00
[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/
[3]:https://github.com/wopian/agc-assembly
[4]:https://github.com/jimlawton/AGC-Assembly
[5]:https://github.com/Alhadis/language-agc
[6]:https://github.com/wopian/agc-assembly#user-settings
2017-02-14 00:07:17 +00:00
[7]:https://github.com/chrislgarry/Apollo-11/issues/159