GitHubのissueを活用した個人アプリの開発ステップ


開発ステップ

ステップ1 issueの作成

まず、GirHubの作業リポジトリでissuesを開き、New issueをクリックする。
タイトルを入力(必須)し、内容を入力(☑︎を押すとチェックボックスが作成されるので便利、『・』や『番号』などある)、完了したらSubmit new issueをクリックしてissueを作成する。
issueが作成されるので、このissueに基づいてブランチを作成する。このときissueに#番号が作成される。この#番号でコミットを紐付ける。

ステップ2 ローカルリポジトリでブランチを切る

 # ローカルリポジトリ、ターミナルでブランチを作成。
 # ブランチ名に issue の #番号 を入れるとわかりやすい(ブランチは特に関連付けされる訳ではない)。
 $ git checkout -b ブランチ名#番号 もしくは $ git branch ブランチ名#番号
 $ git checkout ブランチ名#番号

ステップ3 ローカルリポジトリ、ブランチ上でひたすら作業

issueを意識して作業をする。作業中に issue と作業内容がズレるやるべきことが出てきたらその都度備忘録的にissueを作成してもOK。

ステップ4 ローカルリポジトリでコミットとリモートリポジトリにプッシュ

作業が終わった場合。変更内容を確認 → ステージに上げる → コミット → リモートにプッシュをする。

  $ git status
  $ git diff
  $ git add .
  (このとき コミットコメントに issue の #番号 を必ず入れる。)
  $ git commit -m '投稿機能実装 #番号'
  $ git push origin ブランチ名#番号

ステップ5 GitHub(リモートリポジトリ)でプルリクエストを作成しマージする

プルリクエスト作成の前にGitHubに行ったらissueをクリックし、コミットがissueと関連付けられていることを確認できたらプルリクエストを作成する。タイトルにコミットコメントが自動で入力される(この#番号によりissueとプルリクエストも関連付けされる)。適時コメントを入力(チーム開発の場合はレビューをしてもらうため、それを意識してコメントできると良い)。Create pull request でプルリクエストを作成し、Merge pull requestでマージを完了する。

ステップ6 issueを確認してクローズする

issueに移りCloseボタンを押して、Closedと表示されていれば完了。

ステップ7 ローカルリポジトリのマスターブランチをリモートリポジトリと同じ状態にする

最後にローカル環境でマスターブランチに移動して更新

 $ git checkout master 
 $ git pull origin master