Apollo-11/CONTRIBUTING.ja.md
2020-12-22 17:02:38 +00:00

6.2 KiB
Raw Blame History

コントリビュート

🎌 Čeština, Deutsch, English, Español, Français, Italiano, Kurdi, Lietuvių, Nederlands, Norsk, Polski, Português, Türkçe, Ελληνικά, العربية, 日本語, 正體中文, 简体中文, 한국어

このリポジトリのソースコードは紙の印刷物から手動でデジタル化された為、いくつかのタイプミスやその他の不一致が誤って導入されています。以下のスキャンしたプリントアウトと一致する様にコードを変更する必要があります:

便利な拡張機能

GitHubには、組み込みのAGCアセンブリ言語の構文サポートがあります。残念ながらコードエディターにはありませんが、次のエディターにシンタックスハイライトをサポートするAGC言語拡張機能があります:

† オートフォーマットをサポート

フォーマット

注意: GitHubと上記の拡張機能により、正しいフォーマットが自動的に使用されます。

  • タブでインデントする
  • タブ幅は8を使用する
  • 末尾の空白を削除する

確認方法は?

スキャンとこのリポジトリ内のソースコードとの間の不一致がある場合。

コメント

文字起こしされたコードのコメントはスキャンと正確に一致しなければなりません

校正中に注意する必要がある一般的な問題には、次のものがありますが、これらに限定されません:

誤植

いくつかの場所において、元の開発者がコメントを書いている中で誤植をしています。これらのいくつかは、最初のデジタル化の際に修正がされていますが、デジタル化によってスキャンに存在しなかった誤植も発生してしまいました。

例えば、デジタル化されたコメントに SPACECRAFT が含まれているが、 SPAECRAFT が印刷されたスキャンの場合、デジタル化は SPAECRAFT に修正しなければなりません(C が抜けている)。

同様に、単語のデジタル化にタイプミスがあるが、スキャンでスペルが正しい場合は、タイプミスを修正しなければなりません

スペース

  • コメント内の2つの文字間のスペースは、スキャンと一致すべきです。多くの場合(#316のディスカッションを参照)、次の規則に従う必要があります:
    • 新しい単語の為の単一のスペース。
    • 新しい文章の為の2個のスペース。
    • インデントの為の3個のスペース。

スキャンのすべてのページがこの一般化に従っている訳ではありません。スキャンに2個のスペースではなく1個のスペースしかない場合、1個のスペースを使用して下さい。

改行

  • 列1の R0000 での改行は、スキャンと正確に一致する必要があります。
  • 列1の R0000ない 改行は、1行または2行の空白行のみを含める必要があります。
    • 空白の改行が2つ以上ある場合は、余分な改行を削除します。
      • 列1に R0000 が含まれる行は、これにカウントされません。
    • ソース画像では、これらは列8の印刷されていない数字によって作成されました。2はダブルスペース単一の空白行を強制し、3はトリプルスペース二重の空白行を強制しました。値4-8は定義されていますが使用されていません。詳しくは#159をご覧ください。

例えば、次の通りです:

R0819   SUBROUTINE TO SKIP...
R0820



 0821   LAMPTEST  CS  IMODES33

これになるはずです:

R0819   SUBROUTINE TO SKIP...
R0820


 0820   LAMPTEST  CS  IMODES33

注意

PRを作成する前に、変更がスキャンと一致していることを確認して下さい