kjodle/Apollo-11
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

fix: markdown linting errors

Browse Source
This commit is contained in:
James Harris 2020-10-09 19:55:22 +01:00 committed by GitHub
parent 16aa2154b2
commit 147aeaa6a6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
CONTRIBUTING.md
View File

@ -78,7 +78,7 @@ Any discrepancies between the scans and the source code in this repository.
### Comments
Comments in the transcribed code **MUST** match the scans **exactly**.
Comments in the transcribed code **MUST** match the scans **exactly**.
Common issues you should look out for while proofing include, but not limited to:
@ -86,10 +86,10 @@ Common issues you should look out for while proofing include, but not limited to
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`).
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: