GitHubのissueを活用した個人アプリの開発手順を書いてみた

5911 ワード
チーム開発 issue GitHub 個人開発 Git Git テキストリンク

この記事を書いたきっかけ

実務未経験からITエンジニアへの転職を目指しており、Ruby on Rails を用いたWEBアプリケーション（ポートフォリオ）開発をしている。チーム開発を見据え、GitHubでissue管理を用いた開発をしているが、issue の活用が開発において非常にやりやすく、役立っているので記事にしてみた。
以下で開発手順を解説します。

おかげさまで2020年8月から、エンジニアとして転職して働くことができています

前提として

Git,GitHubの基本的な概念、仕組み、基本的な用語、コマンドについては解説しません。(ローカル/リモート/リポジトリ/コミット/ブランチ/マージ/プルリクエストなど）

Git、GitHub についてあまり理解していない方は最後にリンクで載せている Udemy の教材もおすすめです。

issueとは？

「issue」直訳すると、〔議論すべき〕重要な話題［問題］、問題点、論点、争点、〔問題の〕核心、急所　などの意味になる。
GitHub での issue は repository ごとに管理ができ、repository を見ることができれば誰でも発言が可能である。
開発チームの運用方針によっても使われ方は異なると思うが、私の場合は主にタスク管理ツールとして使用。

issueを活用するメリット

  • issue に基づいてブランチを切り、作業、コミットすることで自分のやるべきことが明確になり、作業効率UP。
  • issue ごとに作業、コミットすることで達成感を得ながら開発ができる。モチベーションUP。
  • やるべきことが思い浮かんだ際に issue を作成しておくことで、タスクの備忘録になる。
  • issue、コミット、プルリクエスト を関連づけることができるため、後から変更内容を追いやすい。

#開発手順

  1. issue を作成
  2. ローカルリポジトリでブランチを切る
  3. ローカルリポジトリ、ブランチ上でひたすら作業
  4. ローカルリポジトリでコミット & リモートリポジトリにプッシュ
  5. GitHub（リモートリポジトリ）でプルリクエストを作成して、ブランチをマージ
  6. issue を確認してクローズ
  7. ローカルリポジトリのマスターブランチをリモートリポジトリと同じ内容にする

以下で詳しく説明↓↓

1. issue を作成

まず GitHub の作業リポジトリで issues を開き、New issue をクリック。 次に ①タイトルを入力（必須） ②内容を入力 （☑︎を押すとチェックボックスが作成されるので便利） ③よければ Submit new issue をクリックして issue を作成 こんな形で issue が作成されるので、この issue に基づいてブランチを作成。このとき issue に #番号 が作成される。この #番号 でコミットを紐付ける。

2. ローカルリポジトリでブランチを切る

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

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

issue を意識して、脇目も振らず作業に没頭。

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

4. ローカルリポジトリでコミット & リモートリポジトリにプッシュ

作業が終わったら、

 変更内容を確認 → ステージに上げる → コミット → リモートにプッシュ

$ git status
$ git diff

$ git add .

（このとき コミットコメントに issue の #番号 を必ず入れる！）
$ git commit -m '投稿機能実装 #番号（今回だと#2)'

$ git push origin ブランチ名#番号

5. GitHub（リモートリポジトリ）でプルリクエストを作成 → マージ

プルリクエスト作成の前に、GitHub に行ったら issue をクリック。コミットが issue と関連付けられていることを確認できたらプルリクエストを作成。 ①タイトルにコミットコメントが自動で入力される（この #番号 により issue とプルリクエスト も関連付けされる） ②適時コメントを入力（チーム開発の場合はレビューをしてもらうため、それを意識してコメントできるとgood。自分は現状あまりできてないかも） ③良ければ Create pull request でプルリクエストを作成 Merge pull request でマージを完了する # 6. issue を確認してクローズ Closed と表示されていればOK

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

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

 $ git checkout master 
 $ git pull origin master(チーム開発では fetch + merge のが無難かも）

1.に戻り繰り返し作業開始！

補足

  • issue #番号の順番通りに作業する必要はなく前後しても構わない。
  • 過去の issue およびコミットに関連付いた内容で修正したい箇所があった場合に新しい issue に関連付けることができる。

参考記事、教材

↓↓初心者の方にこちらの Udemy 教材めっちゃおすすめです！セールの時にぜひ！

最後に

見ていただいてありがとうございます。
Qiita 初投稿めっちゃ疲れました。
ご指摘、補足などなどありましたら是非ともよろしくお願いします！