2021年10月22日 開発時のGitHubの使い方
開発をするときは、以下を使い分けると良いです。
- Milestone
- Issue
- Pull Request
大まかな流れは以下のようになります。
- Milestoneを作ります。期限を設定できます。
- issueを作りたいMilestoneをクリックします。
- issueを作ります。
- issueにラベルをつけます。
- ローカルで作業してpushします。
- プルリクを出します。
- 作成したPull RequestにIssueを紐付けします。
- Pull Requestが閉じると同時にIssueも閉じます。
- 終了。
Milestoneの分け方
例えば、環境構築までは第1フェーズとし、機能追加を第2フェーズ、レイアウト調整を第3フェーズとして分け、それぞれに期限を設け、関連するissueをまとめると良いでしょう。
issue書き方
名前は、Issueなので〇〇機能とか〇〇作成などが一般的かと思います。
例)
- ユーザー作成機能・ログイン機能
- ヘッダーフッター作成
以下はざっくりした書き方ですが、自分の中での実装イメージをイシューで詳細に整理してから実装する方が良いかもしれません。
Pull RequestとIssueを紐付ける
プルリクエストの作成画面で、Closes #n<紐付けたいIssueの番号> と書くことで、プルリクエストとIssueを紐付けることができます。
その状態でCreate pull requestを押すことで、表示されたページのLinked issuesの項目にIssueが紐付いていることが確認できます。
以下の画像のようにプルリクエスト作成画面のメニューバーからイシューと紐付けることも出来ますし、イシューの編集画面からプルリクエストと紐付けることも出来ます。
参考になるラベルの付け方
issueにラベルをつけることで、issueをジャンルごとに分別できます。
あのTripable作者のyunoさんのMilestoneやラベルの付け方が大変参考になりましたので、引用させていただきます。 ラベルのカラーリングも拘られているのでしょうか、わかりやすいですね。
現場ではよりチームで共有しながら開発を進めるために必ず必要です。GitHubの使い方については今後も勉強して共有していきます。
labelをカスタマイズする場所
ここの歯車をクリックすると
Edit labelsからカスタマイズできます。