fork して OSS に貢献する
オープンソースソフトウェア(OSS)のリポジトリには、普通は書き込み権限がありません。それでも fork(フォーク) を使えば、誰でも変更を提案できます。ここではその流れと、初めての貢献で気をつけることをまとめます。
チーム内の PR との違い
| チーム内のリポジトリ | OSS(権限がないリポジトリ) | |
|---|---|---|
| push 先 | 同じリポジトリに直接ブランチを push | 自分の fork に push |
| PR の向き | 同じリポジトリ内のブランチ → main | 自分の fork のブランチ → 元のリポジトリの main |
| リモート | origin だけ | origin(自分の fork)と upstream(元のリポジトリ) |
全体像
元のリポジトリ(upstream) ──fork──▶ 自分の fork(origin)
▲ │
│ PR clone│ ▲ push
│ ▼ │
└────────────────────────── 手元のリポジトリ- GitHub 上で元のリポジトリを fork(自分のアカウントにコピー)
- 自分の fork を clone
- 元のリポジトリを
upstreamとして登録 - ブランチを切って変更し、自分の fork に push
- 自分の fork から元のリポジトリに向けて PR を作る
手順
1〜3. fork・clone・upstream の登録
GitHub で元のリポジトリを開き、「Fork」ボタンを押します。次に、自分の fork を clone します。
git clone <自分の fork の URL>
cd <リポジトリ名>
git remote add upstream <元のリポジトリの URL>
git remote -v
# origin <自分の fork> (fetch)/(push)
# upstream <元のリポジトリ> (fetch)/(push)upstream という名前は慣習です(別の名前でも動きます)。GitHub CLI を使っている場合、gh repo fork --clone で fork・clone・upstream の登録をまとめて行えます。
4. ブランチを切って変更する
作業を始める前に、元のリポジトリの最新を取り込みます。
git switch main
git fetch upstream
git merge upstream/main # 自分の main を元のリポジトリに追いつかせる
git switch -c fix/typo-in-readme
# …編集・コミット…
git push -u origin fix/typo-in-readmefork の main で直接作業しない のがコツです。main は「元のリポジトリの写し」としてきれいに保っておくと、同期が楽になります。
5. PR を作る
push すると GitHub に「Compare & pull request」のボタンが表示されます。PR の向きが 元のリポジトリの main ← 自分の fork のブランチ になっていることを確認して作成します。
レビューを受けて修正する
メンテナー(管理者)から修正を頼まれたら、同じブランチにコミットして push するだけで PR に反映されます。
元のリポジトリの main が進んで PR がコンフリクトした場合は、最新を取り込みます。
git fetch upstream
git merge upstream/main # または git rebase upstream/main
git push # rebase した場合は git push --force-with-leaseマージされたら
git switch main
git fetch upstream
git merge upstream/main
git push origin main # 自分の fork の main も更新
git branch -d fix/typo-in-readme
git push origin --delete fix/typo-in-readmeGitHub の fork の画面にある「Sync fork」ボタンでも、fork の main を元のリポジトリに追いつかせることができます。
貢献する前に読むもの
多くのプロジェクトは、リポジトリに次のようなファイルを置いています。PR を作る前に必ず目を通しましょう。
| ファイル | 書いてあること |
|---|---|
README.md | プロジェクトの概要、使い方 |
CONTRIBUTING.md | 貢献の手順、開発環境の作り方、コーディング規約、テストの実行方法 |
CODE_OF_CONDUCT.md | コミュニティでの行動規範 |
LICENSE | ライセンス。自分の貢献もこの条件で公開されることになる |
.github/PULL_REQUEST_TEMPLATE.md | PR に書くべき項目 |
プロジェクトによっては、コミットへの署名(DCO の Signed-off-by 行)や、CLA(貢献者ライセンス同意書)への同意を求められることがあります。
初めての貢献のコツ
- 小さく始める。 ドキュメントの誤字、分かりにくい説明の改善、テストの追加などは歓迎されやすい
good first issueラベルを探す。 初めての人向けに用意された Issue に付けられていることが多い- 大きな変更は先に Issue で相談する。 いきなり大きな PR を送ると、方針が合わずに閉じられることがある
- 1 つの PR に 1 つの目的。 関係ない修正を混ぜない
- PR の説明に「何を・なぜ」を書く。 関連する Issue があれば
Closes #番号でつなぐ - CI が通ることを確認する。 テストや lint が落ちていたら直してからレビューを待つ
- メンテナーの多くはボランティア。 返事が遅くても気長に待ち、丁寧なやりとりを心がける
よくある疑問
Q. fork したら元のリポジトリの更新は自動で反映される?
されません。上の手順のように upstream から取り込むか、「Sync fork」を使います。
Q. PR が閉じられてしまった。 方針の違いや、すでに別の対応が進んでいたなど、理由はさまざまです。コメントを読み、分からなければ丁寧に質問してみましょう。経験として次に活かせます。
Q. 自分の fork は消してもいい? PR がマージまたはクローズされた後なら消して構いません。また貢献したくなったら、改めて fork できます。
PR そのものの基本は プルリクエストとチーム開発の流れ、リモートの扱いは リモートリポジトリ を参照してください。