GitHubで気に入ったパッケージを見つけたけれど、簡単な機能を追加したい、見つけたバグを修正したい、あるいはオープンソース全体に貢献したいと思ったことはありませんか？ソーシャルコーディングのトレンドに参加し、あなたのスキルをシェアして、オープンソースの世界に貢献しましょう。この記事では、GitHub または任意のホスト型 git サービス上のリポジトリにコードをコントリビュートする方法を学びます。

設定の取得

この記事は、すでにGitHubのアカウントをお持ちの方を想定しています。お持ちでない方は、すぐに無料アカウントに登録してください。または、ターミナルで以下のコマンドを実行し、gitがインストールされていることを確認します。

git --version

バージョン番号の代わりに「コマンドが見つかりません」というメッセージが表示された場合は、以下のコマンドでgitをインストールすることができます。

sudo apt-get -y install git

フォークされたリポジトリ

まず、参加したいリポジトリを選択し、Webブラウザでアクセスする必要があります。どのリポジトリを選択すればよいかわからない場合は、https://github.com/mdizak/muou demo にあるデモリポジトリを使用することができます。これは簡単なデモで、テストや学習のためにこれに対してプルリクエストを作成することは歓迎されます。

Webブラウザでリポジトリを表示する際、Forkリポジトリボタンを探してクリックします。これにより、リポジトリが自分のGitHubアカウントに転送され、そこにアクセスできるようになります。次に、新しくフォークしたリポジトリをクローンする必要があるので、ローカルコンピュータでターミナルを開き、実行してください。

git clone https://github.com/myusername/muo_demo.gitcd muo_demo

もちろん、上記のURLはフォークした新しいリポジトリのものに変更してください。クローン後、以下のコマンドで元のリポジトリを上流リポジトリとして追加します。

git remote add upstream https://github.com/mdizak/muo_demo.git

上のコマンドの URL を、クローンした元のリポジトリの URL に変更してください。これは、git に対して、作業中の親リポジトリであることを意味します。

ローカルリポジトリの準備

毎回新しいコントリビューションの処理を開始する前に、親リポジトリの最新のコードベースを実行していることを確認してください。プロジェクトディレクトリで、ターミナルから次のコマンドを実行してください。

git checkout mastergit pull upstream master && git push origin master

最初のコマンドは、現在masterブランチで作業していることを確認し、2番目のコマンドは親リポジトリをローカルおよびGitHubリポジトリと同期させるものです。これにより、最新のリポジトリを変更し、古いコードで作業していないことを保証します。

また、プロジェクトに contribution.md ファイルがあるかどうかを確認し、ある場合は上記で言われていることに従っていることを確認してください。プロジェクトによっては、寄付の方法について具体的なガイドラインを設けている場合がありますので、必ずこれに従ってください。

新しいブランチを作成する

このコントリビューションに対するすべての変更を保持する新しいブランチを作成する必要があります。このブランチは、後でプロジェクトのメンテナによってメインの GitHub リポジトリにマージされます。ブランチは英数字でなければならず、任意の名前を付けることができる。

必須ではありませんが、一般的にブランチ名の前に、簡単なバグフィックスであれば hotfix/、追加機能であれば feature/ を付けるのが礼儀とされています。目的のブランチ名を選択し、以下のコマンドを実行します。

git checkout -b feature/my_cool_feature

機能/バグフィックスごとに常に別のブランチを作成し、1つのブランチに複数の貢献を含めないようにしてください。これは、円滑な開発プロセスを維持し、また、あなたの貢献が受け入れられ、プロジェクトに含まれることを保証するのに役立ちます。

ブランチが作成されたので、標準的な git のワークフローに必要な変更を加えます。

リクエストの送信と作成

貢献が完了したら、適切なコミットメッセージを使用してコミットし、以下のコマンドを使用してフォークされたリポジトリにプッシュしてください。

git commit --file commit.txtgit push -u origin feature/my_cool_feature

最後のステップは、新しい貢献が待っていることをプロジェクトメンテナに警告するために、プルリクエストを作成することです。WebブラウザでフォークしたGitHubのリポジトリにアクセスすると、ブランチを変更できるドロップダウン・ボタンが表示されます。新しく作成されたブランチに変更すると、次のページで新しいプルリクエストを作成するためのリンクが表示されます。

このリンクをクリックすると、コミットメッセージと、あなたがコードに加えたすべての変更が表示されるページが表示されます。すべてが正しいことを確認し、メンテナに必要なメッセージを追加して、プルリクエストを提出します。

githubに貢献し続ける

おめでとうございます！GitHub プロジェクトへのコントリビューションが完了しました。

あなたのプルリクエストは、プロジェクトメンテナによるレビューと承認を待っている状態です。承認されたかどうか、また彼らがあなたに提供するニュースは、メールで通知されます。GitHub でプロジェクトに貢献する方法を学んだら、次はオープンソースコミュニティの発展に貢献しましょう。