GitHub Issueを使ってみようと思ったメモ

雰囲気で使っていて細かいところ分かってなかったので自分用のメモ。

https://github.com/akahigeg/issue-sandbox/issues

Issueの設定項目

• Title: タイトル
• Comment: コメント
• Assinees: 担当者
• Labels: ラベル
• Milestone: マイルストーン
• Projects: 紐づけるプロジェクト
• Development: 関連するブランチやプルリク

このうち自明なものはTitle、Comment、Assignees。Developmentも難しいことはない。

• タイトルは分かりやすく
• コメントは「#」を使った他のIssueへの参照と「@」を使った他のユーザーへのメンションを覚えておくと良い
• 担当者は一方的に突っ込むと反感を買うことがあるので注意しとこう
• Developmentは関連するブランチやプルリクがあればリンクを表示できる

ラベル Labels

• デフォルトでbug、enhancementといったラベルがある
• ひとつのIssueに複数のラベルを付けられる
• 任意のラベルを追加して使うことが可能
• Issueのリストをラベルで絞り込みできる
• 優先度管理にラベルを使う運用は割とポピュラーぽい

ラベルの運用は最初に決めておく＆適宜見直していくのがいいかなというかんじ。

マイルストーン Milestone

• 開発の区切り
• Issueはひとつ以下のマイルストーンに属する（複数のマイルストーンの配下になることはできない）
• 期日を設定できる（設定しないこともできる）
• Issueに期日は設定できないので、GitHubで期日を扱えるのはここだけ
• 配下のIssueをCloseするとバーがプログレスする（ルー語）

まとまった数のIssueを優先度付けて対応して行くならマイルストーンは使った方がいいかなというかんじ。

プロジェクト Projects

• タスクのステータス（ToDo, InProgress, Done）をスプレッドシートやカンバン形式で管理できる
• GitHubのIssueやPull Requestと連動したタスク管理ができる
• 連動しないタスクも管理できる（ふわっとした要望とか突っ込める）

Issueの対応状況などを見える化したい場合は使うと便利かなというかんじ。

他のプロジェクト管理ツールを使う場合はもちろん不要。必ずしも使う必要はない。