目次
1.はじめに
2.イシュー発見
3.コントリビュートのガイドライン確認
4.Gitリポジトリのクローン後ローカル設置
5.イシュー修正後PR提出
6.結論
1. はじめに
オープンソースを使用していて問題点を見つけたことがありますか。とっても単純なタイプミスからコードのバグまで様々な種類があります。時間があれば、オープンソースに寄与してみるのはどうでしょうか。オープンソースは誰でも参加できる空間であり、そのような寄与一つ一つが積み重なればオープンソースコミュニティ全体に有益な影響を与えます。これから実際の事例を通してGitHubのオープンソースに寄与する方法を見てみます。
2. イシュー発見
最近bootstrap_formというオープンソースを使っていますが、公式文書のREADME.mdファイルにあるリンク3つ(bootstrap_form_with、bootstrap_form_for、bootstrap_form_tag)が動作しないことを気づきました。
3. 寄与ガイドライン確認
大抵のオープンソースはオープンソースに寄与したい人のため、CONTRIBUTING.mdというファイルに詳しくルールを説明しています。bootstrap_formの寄与ルールを読んでみたらコミットに[ci skip]というテキストを挿入すると、提出されたPRがマージされる時にCIのパイプラインが実行されないと説明しています。コードではなくただのREADME.mdファイルの修正なので、忘れないで入れてあげましょう。寄与ルールを無視してPRを提出すると、PRが拒絶される可能性があるので必ず寄与ルールを守りましょう。
4. Gitリポジトリのクローン後ローカル設置
寄与ルールの確認が終わったので、Gitリポジトリを複製してローカルに設置しましょう。まず、bootstrap_formの原本GitリポジトリをForkして複製します。
複製したリポジトリに移動し、Clone ボタンを押すと表示されるメニューから、その複製リポジトリのアドレスをコピーします。
ターミナルでgitコマンドとコピーしたアドレスを使用してローカルコンピューターに複製したリポジトリを設置します。
git clone https://github.com/minimabot/bootstrap_form.git
ローカルコンピューターにbootstrap_formの設置が終わったら、そのディレクトリに移動して新しいブランチを生成します。ドキュメントのリンクを修正するPR提出なので、ブランチ名をdocs/fix-broken-linksにします。
git checkout -b docs/fix-broken-links
5. イシュー修正後PR提出
これでイシューを修正する準備は終わりました。設置した複製したリポジトリからREADME.mdファイルを開き、動作しないリンクを見つけて修正します。マークダウンのセクションリンクを間違って使用しています。簡単な作業なので1分もかかりません。
修正が終わったら、README.mdファイルをGitステージに上げてコミットします。
git add README.md && git commit
簡単な修正でも、レビューアのためにコミットメッセージを詳細に作成します。
Fix broken section links in README.md [ci skip]
This PR fixes the issue of broken section links in the README.md file.
The following section links have been corrected for accurate navigation:
- bootstrap_form_with
- bootstrap_form_for
- bootstrap_form_tag
コミットメッセージ作成まで終わったら、forkで複製したリポジトリにプッシュします。
git push origin docs/fix-broken-links
プッシュができたら、GitHubページでPRの提出が有効になることが確認できます。
活性化されたボタンを押して移動すると、すでにコミット内容に基づいてPR内容が作成されています。 ブランチとコミット内容を確認した後、問題がなければCreate pull requestボタンを押してPR提出を完了します。
提出したPRのレビューを待ちます。 そしてPRがマージされるとbootstrap_formのコントリビューターになります。🎉🎉
6. 結論
実際の事例を通してオープンソースに寄与する方法を見てみました。 オープンソースを修正するためには個人的な時間を使う必要があります。 個人的な時間を奪われると思うかもしれません。しかし、私は何かに貢献できるという気持ちを大事にしています。そんな喜びを皆さんにも感じてもらえたらと思います。