From 59330826b4e8ccf8722f5d4e219a06cbefcde9a1 Mon Sep 17 00:00:00 2001 From: Ikko Ashimine Date: Wed, 23 Dec 2020 02:02:38 +0900 Subject: [PATCH] update CONTRIBUTING.ja.md (#806) --- CONTRIBUTING.ja.md | 47 ++++++++++++++++++++++------------------------ 1 file changed, 22 insertions(+), 25 deletions(-) diff --git a/CONTRIBUTING.ja.md b/CONTRIBUTING.ja.md index 6526e10..0f66ad7 100644 --- a/CONTRIBUTING.ja.md +++ b/CONTRIBUTING.ja.md @@ -41,7 +41,7 @@ [ZH_CN]:CONTRIBUTING.zh_cn.md [ZH_TW]:CONTRIBUTING.zh_tw.md -このリポジトリのソースコードは紙の印刷物から手動でデジタル化された為、いくつかのタイプミスやその他の不一致が誤って導入されています。スキャンしたプリントアウトと一致する様にコードを変更する必要があります: +このリポジトリのソースコードは紙の印刷物から手動でデジタル化された為、いくつかのタイプミスやその他の不一致が誤って導入されています。以下のスキャンしたプリントアウトと一致する様にコードを変更する必要があります: - [AGC printouts for Comanche][8] - [AGC printouts for Luminary][9] @@ -84,12 +84,30 @@ GitHubには、組み込みのAGCアセンブリ言語の構文サポートが ## 確認方法は? -スキャンとこのリポジトリ内のソースコードとの間の不一致: +スキャンとこのリポジトリ内のソースコードとの間の不一致がある場合。 ### コメント -- 文字起こしされたコードのコメントはスキャンと正確に一致する必要があります - - これには意図的なタイプミス、またはコメント全体の削除/追加が含まれる場合があります。 +文字起こしされたコードのコメントはスキャンと**正確**に一致**しなければなりません**。 + +校正中に注意する必要がある一般的な問題には、次のものがありますが、これらに限定されません: + +#### 誤植 + +いくつかの場所において、元の開発者がコメントを書いている中で誤植をしています。これらのいくつかは、最初のデジタル化の際に修正がされていますが、デジタル化によってスキャンに存在しなかった誤植も発生してしまいました。 + +例えば、デジタル化されたコメントに `SPACECRAFT` が含まれているが、 `SPAECRAFT` が印刷されたスキャンの場合、デジタル化は `SPAECRAFT` に修正**しなければなりません**(`C` が抜けている)。 + +同様に、単語のデジタル化にタイプミスがあるが、スキャンでスペルが正しい場合は、タイプミスを修正**しなければなりません**。 + +### スペース + +- コメント内の2つの文字間のスペースは、スキャンと一致**すべきです**。多くの場合（[#316][10]のディスカッションを参照）、次の規則に従う必要があります: + - 新しい単語の為の単一のスペース。 + - 新しい文章の為の2個のスペース。 + - インデントの為の3個のスペース。 + +スキャンのすべてのページがこの一般化に従っている訳ではありません。スキャンに2個のスペースではなく1個のスペースしかない場合、1個のスペースを使用して下さい。 ### 改行 @@ -120,27 +138,6 @@ R0820 0820 LAMPTEST CS IMODES33 ``` -### スペース - -- 文字列間内の2つの文字間のスペースは、次の規則に従う必要があります（[#316][10]のディスカッションを参照）: - - 新しい単語の為の単一のスペース。 - - 新しい文章の為の2個のスペース。 - - インデントの為の3個のスペース。 - -例えば、次の通りです: - -```plain - 1) FOO BAR BAZ QUX QUUX QUUZ. CORGE, GRAULT, - GARPLY, WALDO. -``` - -これになるはずです: - -```plain - 1) FOO BAR BAZ QUX QUUX QUUZ. CORGE, GRAULT, - GARPLY, WALDO. -``` - ## 注意 PRを作成する前に、変更がスキャンと一致していることを確認して下さい！