ITSUKI.
技術712 文字2 分

Day 19|コントリビューション — 差分を、伝わる問題分析へ

#Codex#ソースコードリーディング#図解

この章しょうの答こたえ

再現さいげん条件じょうけんと根拠こんきょがそろうと、小ちいさな発見はっけんも他ほかの人ひとが検証けんしょうできる。

手元てもとで動うごく修正しゅうせいができても、そのまま採用さいようされるとは限かぎりません。何なにが困こまるのか、どう再現さいげんするのか、既存きぞんの報告ほうこくとどう違ちがうのかを説明せつめいできると、調査結果ちょうさけっかを共有きょうゆうする価値かちが生うまれます。

01|図でつかむ

図19|コントリビューション

実装じっそう差分さぶんだけでなく、第三者だいさんしゃが確たしかめられる再現手順さいげんてじゅんを用意よういする。

02|3つのポイントで理解する

1. その時点の参加方法を読む

contributing 文書ぶんしょやテンプレートを確認かくにんします。過去かこの受け入れ方うけいれかたを現在げんざいにも当あてはめず、Issue と PR のどちらで何なにを求もとめているかを調しらべます。

2. 似た報告と照合する

症状しょうじょう、バージョン、操作そうさ手順てじゅんを比くらべます。同おなじ言葉ことばが含ふくまれていても、発生はっせい条件じょうけんや原因げんいんが違ちがう場合ばあいがあります。逆ぎゃくに、別べつの表現ひょうげんでも同おなじ不具合ふぐあいかもしれません。

3. 観察と仮説を分けて書く

再現さいげんした症状しょうじょうと、ソースコードから推測すいそくした原因げんいんを分わけます。期待きたいする動うごき、実際じっさいの動うごき、最小さいしょう手順てじゅん、対象たいしょう commit があれば、読よむ人ひとが同おなじ地点ちてんから調査ちょうさを始はじめられます。

03|ソースで確かめる

以下いかの検索けんさくは Codex リポジトリのルートで実行じっこうします。最初さいしょに対象たいしょう commit を記録きろくし、検索結果けんさくけっかから定義ていぎと呼び出よびだし元もとを一ひとつずつ開ひらいてください。

git rev-parse --short HEAD
cat docs/contributing.md
gh issue list --repo openai/codex --state all --search "slash command alias"

読よむ入口いりぐち: docs/contributing.md 。リンク先さきは照合しょうごうに使つかった固定こてい commit のファイルです。手元てもとの版はんと異ことなる場合ばあいは、上うえの検索語けんさくごから探さがし直なおします。

小さく試す

既存きぞんの Issue を一ひとつ読よみ、観察かんさつされた事実じじつ・原因げんいん仮説かせつ・追加ついかで必要ひつような検証けんしょうを三さん列れつに整理せいりします。

04|30秒で復習

  • 最新さいしんの参加方法さんかほうほうを確認かくにんする。
  • 重複ちょうふく調査ちょうさでは条件じょうけんまで比くらべる。
  • 事実じじつと仮説かせつを区別くべつして伝つたえる。

全ぜん30章しょうの目次もくじへ