オープンソースプロジェクトへの貢献に興味を持っている皆さん、こんにちは！「コードを読んで勉強はしているけど、実際に貢献するとなると、どうすれば良いのかわからない...」「プルリクエストってよく聞くけど、具体的にどういう手順で送れば良いの？」「マナー違反をして、怒られたりしないかな...」などと、不安に思っていませんか？
この記事では、そんな皆さんのために、オープンソースプロジェクトに初めてプルリクエストを送る方法を、GitHub を例に、ステップバイステップで丁寧に解説していきます。
オープンソースプロジェクトには、それぞれ独自のルールや文化がありますが、ここでは多くのプロジェクトで共通する、一般的なお作法を中心に説明します。この記事を読めば、きっとあなたも自信を持って、オープンソース貢献への第一歩を踏み出せるはずです。
1. 貢献したいプロジェクトを見つけよう！
まずは、貢献したいオープンソースプロジェクトを見つけましょう。GitHub には、数え切れないほどのプロジェクトが存在します。自分が興味を持っている技術や、好きなソフトウェアに関連するプロジェクトを探してみましょう。
1.1 プロジェクトの探し方
GitHub の「Explore」ページや「Topics」ページでは、様々なカテゴリやトピック別にプロジェクトを検索できます。また、Google などの検索エンジンで「{技術名} + オープンソース」といったキーワードで検索するのも良い方法です。
1.2 良いプロジェクトの見分け方
初めての貢献先として適したプロジェクトを見分けるには、以下の点に注目してみましょう。
- 活発に開発されている: コミット履歴やプルリクエストのやり取りが頻繁に行われているプロジェクトは、活発に開発されている証拠です。
good first issueラベルがある: 初心者向けの課題には、good first issueやbeginner-friendlyなどのラベルが付けられていることが多いです。これらのラベルが付いた Issue から、取り組めそうな課題を探してみましょう。README.mdやCONTRIBUTING.mdが整備されている: プロジェクトの概要や、貢献方法について詳しく説明されているプロジェクトは、初心者に優しいと言えます。特にCONTRIBUTING.mdには、コーディング規約や、プルリクエストの手順などが記載されていることが多いので、必ず目を通しておきましょう。
2. プロジェクトのルールを確認しよう！
貢献したいプロジェクトを見つけたら、まずはそのプロジェクトのルールを確認しましょう。多くのプロジェクトでは、README.md や CONTRIBUTING.md といったファイルに、貢献に関するガイドラインが記載されています。
2.1 README.md を読もう！
README.md には、プロジェクトの概要、インストール方法、基本的な使い方などが記載されています。まずは README.md を読んで、プロジェクトの全体像を把握しましょう。
2.2 CONTRIBUTING.md を読もう！
CONTRIBUTING.md には、プロジェクトへの貢献方法について、より詳しく記載されています。コーディング規約、コミットメッセージの書き方、プルリクエストの手順など、プロジェクト固有のルールが定められていることが多いので、必ず目を通しておきましょう。
2.3 行動規範 (Code of Conduct) を確認しよう！
多くのオープンソースプロジェクトでは、行動規範（Code of Conduct）を定めています。行動規範には、プロジェクトの参加者が守るべき倫理的なルールが記載されています。ハラスメントの禁止や、建設的なコミュニケーションの促進など、誰もが安心して参加できるコミュニティを作るためのルールです。貢献を始める前に、必ず行動規範を確認し、内容を理解しておきましょう。
3. 開発環境を準備しよう！
プロジェクトのルールを確認したら、次は開発環境を準備しましょう。
3.1 リポジトリをフォークしよう！
まずは、GitHub 上でプロジェクトのリポジトリを自分のアカウントにフォークします。フォークとは、元のリポジトリを自分のアカウントにコピーする操作です。フォークすることで、元のリポジトリに影響を与えることなく、自由にコードを変更できるようになります。
フォークを行うには、リポジトリのページ右上にある「Fork」ボタンをクリックします。
3.2 フォークしたリポジトリをクローンしよう！
次に、フォークしたリポジトリを自分のローカル環境にクローンします。
bash
git clone https://github.com/your-username/repository-name.gityour-username はあなたの GitHub ユーザー名、repository-name はリポジトリの名前に置き換えてください。
3.3 ブランチを作成しよう！
クローンしたリポジトリで、作業用のブランチを作成します。ブランチを作成することで、main ブランチを直接変更することなく、安全に作業を進められます。
bash
git checkout -b my-first-contributionmy-first-contribution は、作成するブランチの名前です。変更内容がわかりやすい名前を付けましょう。
4. 変更を加えよう！
開発環境の準備ができたら、いよいよコードの変更作業に入ります。
4.1 Issue を選ぼう！
まずは、取り組む Issue を選びましょう。前述の通り、good first issue などのラベルが付いた Issue から探すのがおすすめです。Issue の内容をよく読み、自分が解決できそうな課題を選びましょう。
4.2 コードを変更しよう！
Issue の内容に従って、コードを変更します。CONTRIBUTING.md に記載されているコーディング規約を守って、コードを書きましょう。
4.3 動作確認をしよう！
コードの変更が完了したら、必ず動作確認を行いましょう。プロジェクトによっては、テストコードが用意されていることもあります。テストコードを実行して、変更が既存の機能に影響を与えていないことを確認しましょう。
5. コミットしよう！
変更内容に問題がなければ、コミットします。コミットメッセージは、変更内容を簡潔かつ明確に記述することが重要です。
5.1 変更をステージングしよう！
bash
git add .5.2 コミットメッセージの書き方
コミットメッセージは、以下の形式で記述することが一般的です。
<type>(<scope>): <subject>
<body>
<footer>type: コミットの種類を表します。feat（新機能）、fix（バグ修正）、docs（ドキュメント）、style（スタイル）、refactor（リファクタリング）、test（テスト）、chore（雑務）などがよく使われます。scope: 変更の対象範囲を表します（省略可）。subject: 変更内容を簡潔に記述します。body: 変更内容の詳細を記述します（省略可）。footer: 関連する Issue 番号などを記述します（省略可）。
例えば、README.md にタイポを修正するコミットメッセージは、以下のようになります。
fix(docs): correct typo in README.md
Fixes #123#123 は、修正した Issue の番号です。
5.3 コミットを実行しよう！
bash
git commit -m "fix(docs): correct typo in README.md"6. プルリクエストを送ろう！
コミットが完了したら、いよいよプルリクエストを送ります！
6.1 変更をプッシュしよう！
まずは、ローカルの変更を GitHub 上の自分のリポジトリにプッシュします。
bash
git push origin my-first-contribution6.2 プルリクエストを作成しよう！
GitHub 上で自分のリポジトリにアクセスすると、「Compare & pull request」というボタンが表示されます。このボタンをクリックして、プルリクエストの作成画面を開きます。
6.3 プルリクエストの内容を記入しよう！
プルリクエストの作成画面では、以下の項目を記入します。
- タイトル: プルリクエストのタイトルを入力します。変更内容を簡潔に表すタイトルを付けましょう。
- コメント: 変更内容の詳細や、関連する Issue 番号、その他補足事項などを記入します。特に、なぜその変更を行ったのか、その変更によってどのようなメリットがあるのかを明確に記述することが重要です。
- Reviewers: 必要に応じて、レビュアーを指定します。
6.4 プルリクエストを作成しよう！
すべての項目を記入したら、「Create pull request」ボタンをクリックして、プルリクエストを作成します！
7. レビューに対応しよう！
プルリクエストを作成すると、プロジェクトのメンテナーや他のコントリビューターからレビューを受けられます。レビューでは、コードの改善点や修正すべき点が指摘されることがあります。
7.1 コメントを確認しよう！
プルリクエストのページで、レビューコメントを確認します。
7.2 修正を加えよう！
レビューで指摘された点を修正します。修正が完了したら、再度コミットしてプッシュします。
7.3 コメントに返信しよう！
修正が完了したことを、コメントでレビュアーに伝えましょう。
8. プルリクエストがマージされたら
レビューを経て、プルリクエストが承認されると、メンテナーによって main ブランチにマージされます。これで、あなたの変更が正式にプロジェクトに取り込まれました！おめでとうございます！
8.1 マージ後の確認
プルリクエストがマージされたら、プロジェクトの main ブランチに変更が反映されていることを確認しましょう。
8.2 ローカルブランチを更新
最後に、ローカルの main ブランチを最新の状態に更新しておきましょう。
bash
git checkout main
git pull origin main不要になった作業ブランチは削除しても構いません。
bash
git branch -d my-first-contributionおわりに
初めてのプルリクエスト、お疲れ様でした！最初は緊張したり、戸惑ったりすることも多いと思いますが、この記事で解説した手順を参考にすれば、きっとスムーズにプルリクエストを送ることができるはずです。
オープンソースプロジェクトへの貢献は、自分のスキルアップだけでなく、世界中の人々に貢献できる、素晴らしい経験です。最初は小さな一歩かもしれませんが、その一歩が、やがて大きな成果に繋がります。
さあ、あなたもオープンソースの世界に飛び込んで、一緒にソフトウェア開発の未来を創造しましょう！