貢献の流れ
実際に貢献をしてみましょう
実際に貢献をしてみましょう
OSS貢献においては Forkやブランチの使い方について,理解する必要があります.
ここではハンズオン形式でそれらについて解説します.
OSS と Push権限について
OSS と Push権限について
OSS では,Maintainer に対して Contributor はリポジトリに直接Pushする権限は持ちません.
また,本家のリポジトリが更新されても自分のローカルリポジトリには自動で反映されるわけではありません.
OSS への貢献の準備
OSS への貢献の準備
最初の PullRequest を作成する前にいくつか準備を行いましょう
Forkする
Forkする
GitHub 上でリポジトリをForkします.
Forkしたリポジトリは自分のアカウントの所持するリポジトリとなるため,commit やブランチの作成が可能になります.
Cloneする
Cloneする
Frokしたリポジトリを,普通の開発と同じようにCloneします.
本家リポジトリをremoteとして登録する
本家リポジトリをremoteとして登録する
本家のremote URLを行うことで,本家リポジトリへの追従が容易になります.
$ git remote add upstream <本家のリポジトリのremote URL>
Pull Request の作成手順
Pull Request の作成手順
本家リポジトリに追従する
本家リポジトリに追従する
master ブランチを本家リポジトリに追従します.
$ git checkout master
$ git fetch upstream
$ git merge upstream/master
ブランチを作成する
ブランチを作成する
基本的には Pull Request 毎にブランチを作成すると良いでしょう.
ブランチ名は適宜変更してください
$ git checkout -b my-new-feature
作業を行い,Pushする
作業を行い,Pushする
ソースコードの編集等を 行った後は,通常のGitの操作と同じくcommit と push をします.
コミットメッセージは適宜変更してください
# 作業を行う
$ git commit -am 'Add some feature'
$ git push origin my-new-feature
Pull Request を作成する
Pull Request を作成する
GitHub 上で Pull Request を作成します.