How to develop - JunichiIto/rubyist-connect GitHub Wiki

開発手順

このドキュメントではrubyist-connectの開発手順を説明します。

うまくいかない場合は Issue 等を利用して質問してください。
また、手順の間違いや他の人も困りそうな補足事項があれば、このWikiを自由に編集してもらって構いません。

本家リポジトリをリモートリポジトリとして登録する

本家リポジトリをupstreamという名前のリモートリポジトリとして登録します。
なお、この作業を実施するのは最初の一回だけです。

git remote add upstream [email protected]:yuji-shimoda/rubyist-connect.git

本家リポジトリの最新状態を取り込む

以下の手順で本家リポジトリの最新状態を取り込みます。

git checkout master
git fetch upstream
git merge upstream/master

テストが全てパスすることを確認する

テストが全てパスすることを確認してください。

bin/rspec

テストが動かない/失敗する場合の原因と対策

• migrationが追加された => bin/rake db:migrate を実行
• Gemfileが更新された => bundle install -j4 を実行
• Rubyのバージョンが上がった => .ruby-version を確認して、そのバージョンのRubyをインストール、その後 bundle install -j4
• Travis CIがFailしている => できれば原因を調整して修正する（GitHub issueの発行＆pull request作成）。難しそうならGitHub issueに報告する。
• その他 => コミットログ等を確認して、自力で解決する。難しそうならGitHub issueに報告する。必要に応じてWikiやREADMEを更新する。

GitHub issueで自分をアサインする

GitHub issueから対応するissueを選択し、自分をAssigneeにしてください。
これで「このissueは私がやります」のサインになります。

https://github.com/yuji-shimoda/rubyist-connect/issues

開発用ブランチを作成する

本家リポジトリの最新状態を取り込んだら、開発用ブランチを作成します。

git checkout -b (任意のブランチ名)

開発を実施する

開発用ブランチ内で開発を実施します。

仕様が変わった場合は原則としてテストコードの追加や変更も実施してください。

テストを実行する

開発が終わったらテストを実行し、すべてパスすることを確認してください。

bin/rspec

GitHubにpushする

テストがすべてパスすることを確認したら、GitHubにpushしてください。

git push -u origin (開発用ブランチ名)

Pull requestを作成する

GitHubで自分のアカウントにフォークしたrubyist-connectを開き、pull requestを作成します。
pull requestのコメントには対応したissueのURLを含めてください。

pull requestの作成手順は以下のページの「3. GitHub上で、Pull Requestを作成する」以降を参考にしてみてください。

GitHub初心者はForkしない方のPull Requestから入門しよう

なお、pull requestの送信先は「yuji-shimoda:master（本家リポジトリ）」になります。

GitHub issueをクローズする

対象のGitHub issueをクローズしてください。その際、pull requestのURLをコメントに含めてください。
これで「対応しました」のサインになります。

開発手順は以上です。

参考文献

• GitHubでFork/cloneしたリポジトリを本家リポジトリに追従する