02.ラベル規定
このドキュメントは、GitHub Issueに付与するラベルの種類と、その運用ルールについて定めます。 ラベルを適切に活用することで、タスクの分類、優先度付け、状態管理を効率的に行います。
1. ラベル付与の基本ルール
- カテゴリごとの選択ルール:
- 単一選択 (Single Choice): カテゴリ内のラベルから、必ず1つだけを選択して付与します。
- 複数選択 (Multiple Choice): カテゴリ内のラベルを、0個以上、複数選択して付与できます。
Type:
ラベルは必須: 全てのIssueには、必ず1つのType:
プレフィックスを持つラベルを付与します。- 色の統一感: 同じカテゴリのラベルは、似た色で統一すると視覚的に分かりやすくなります。
ラベルの自動化
ブランチ名に応じたType:
ラベルの自動付与や、単一選択ラベルの自動整理など、一部のラベル操作はGitHub Actionsによって自動化される可能性があります。
詳細は REQ-AUTO-1.0: ラベル自動化機能 を参照してください。
2. ラベル一覧
カテゴリ1: Type
- Issueの種類 (単一選択・必須)
Issueが「何についての」タスクなのかを示します。このカテゴリのラベルは、必ず1つだけ付与してください。
ラベル名 | 色 (推奨) | 説明 |
---|---|---|
Type: Bug(不具合) |
#d73a4a (赤系) |
明確なバグや不具合の報告。 |
Type: Feature(機能) |
#a2eeef (水色系) |
新しい機能の追加に関する提案やタスク。 |
Type: Refact(改善) |
#4CAF50 (緑系) |
既存機能の改善、リファクタリング、パフォーマンス向上。 |
Type: Docs(ドキュメント) |
#0075ca (青系) |
ドキュメントの作成や修正に関するタスク。 |
Type: Chore(設定) |
#cfd3d7 (グレー系) |
ビルド設定、CI/CDの改善、ライブラリ更新など、上記以外の雑務。 |
Type: Question(質問) |
#d876e3 (紫系) |
質問や、仕様に関する相談・議論。 |
カテゴリ2: Priority
- 優先度 (単一選択・任意)
対応の緊急性や重要度を示します。付与する場合は、このカテゴリのラベルから1つだけを選択してください。
ラベル名 | 色 (推奨) | 説明 |
---|---|---|
Priority: Critical🔥 |
#b60205 (濃赤) |
緊急: ユーザーの主要な操作を妨げる、または深刻な脆弱性。Hotfixリリースのトリガーとなる。 |
Priority: High🔼 |
#e99695 (薄赤) |
高: 優先的に対応すべき重要なタスク。計画的なマイルストーン内で対応する。 |
Priority: Medium |
#fbca04 (黄系) |
中: 通常の優先度。 |
Priority: Low🔽 |
#c2e0c6 (薄緑) |
低: 急がない、または時間がある時に対応するタスク。 |
カテゴリ3: Status
- 状態 (複数選択・任意)
IssueやPRが、現在どのような状態にあるかを示します。このカテゴリのラベルは、状況に応じて複数付与することが可能です。
ラベル名 | 色 (推奨) | 説明 |
---|---|---|
Status: In Progress🛠️ |
#ededed (薄いグレー)** |
開発者が現在作業中の状態。担当者が割り当てられ、作業に着手したことを示す。 |
Status: Needs Review👀 |
#fef2c0 (薄黄) |
プルリクエストがレビュー待ちの状態。 |
Status: Blocked🚧 |
#000000 (黒) |
他のタスクや外部要因により、作業がブロックされている状態。 |
Status: Consid(検討中)🤔 |
#bfd4f2 (薄青) |
バックログ状態。対応要否や、どのマイルストーンに含めるかを検討中のアイデアやタスク。 |
Status: Wontfix🤷 |
#ffffff (白) |
議論の結果、対応しないことが決定されたIssue。 |
カテゴリ4: その他 (複数選択・任意)
特定の目的のために使用します。
ラベル名 | 色 (推奨) | 説明 |
---|---|---|
good first issue |
#7057ff (紫系) |
プロジェクトへの最初の貢献として最適な、比較的簡単なIssue。 |
help wanted |
#008672 (濃緑) |
外部のコントリビューターに協力を仰ぎたいIssue。 |