TKYTEL COMMENT 6 東京広域電話網 2025-06-14 TKYTEL COMMENT の投稿と修正とについて 1. 概要 本文書では、TKYTEL COMMENT（以下、文書とする）を投稿したり修正した りすることについて述べる。 2. 文書の投稿 文書の管理は GitHub を用いて行われる。本文書が投稿された時点のレポ ジトリ URL は である。main ブランチ の内容が公開された投稿である。 文書を投稿するには、投稿したいと思う文書を含む commit を伴って pull request する。この際、[TC3] で述べられる体裁になっていることが 望ましいが、必ずしもこの通りである必要はない。 Pull request を受けて、東京広域電話網（以下、網とする）のメンバは 内容を確認する。必要に応じて体裁や内容について推敲を行う。同時に、文 書のファイルを “XX.txt” のように名付ける。ここで、XX は文書番号とし て用いられていない正整数のうち最小のものを必要最低限の桁数で表示した ものである。推敲を終えたところで、当該 pull request を merge する。 その際、関連する commit を全て squash する。新たな commit message は 以下のような書式で記述する。著者が一人であるような場合は Co-authored-by トレイラを添えない。文書の推敲にあたった編集者が著者 の他にいる場合、その編集者は Co-authored-by トレイラに含める。 TKYTEL COMMENT XX Co-authored-by: Alice Co-authored-by: Bob 3. 文書の修正 投稿された文書に誤りがあったり、内容が古くなったりした場合、その文 書を修正できる。修正は GitHub を用いて行われる。 文書を修正するには、修正したいと思う文書の修正箇所を含む commit を 伴って pull request する。なるべく、それぞれの commit が一部分の修正 や関連する一連の修正を含むようにする。一つの pull request に複数の commit を含めても良い。それぞれの commit には、修正に関連する簡単な 説明を含む適切な commit message を添える。 Pull request を受けて、東京広域電話網（以下、網とする）のメンバは 内容を確認する。必要に応じて体裁や内容について推敲を行う。推敲を終え たところで、当該 pull request を merge する。その際、関連する commit を全て squash する。新たな commit message は以下のような書式で記述す る。ここで、YY は修正対象である文書の文書番号を、ZZ は当該文書のエラ ッタ番号として用いられていない正整数のうち最小のものを必要最低限の桁 数で表示したものである。修正の著者が一人であるような場合は Co-authored-by トレイラを添えない。修正の推敲にあたった編集者が著者 の他にいる場合、その編集者は Co-authored-by トレイラに含める。 TKYTEL COMMENT YY (Errata ZZ) Co-authored-by: Alice Co-authored-by: Bob Pull request をマージする直前に、文書のヘッダ部分を以下のように修 正する。 - 文書の一行目を “TKYTEL COMMENT YY (Errata ZZ)” に修正する。 - 必要であれば、最後の発行者名あるいは修正者名の後に行を挿入し、 修正者名を右揃えで配置する。ただし、修正者が既に記載されている著者 あるいは修正者に含まれる場合は、これを行わない。 - 発行年月日あるいは最後の修正年月日の後に行を挿入し、修正年月日を右 揃えで配置する。年月日の書式は発行年月日の書式と同様とする。 4. 補足 むやみやたらな修正は読者を混乱させる。極力修正のないような文書を書 くよう、心掛けるべきである。 以上