デフォルトのラベル
GitHub Issuesにはデフォルトで9つのラベルが存在しますが、微妙に使いづらい...
そこで、このラベルを作り直してみました。
作り直したラベル
ラベルは5種類に分けました。
共同作業に関するラベルはあまり用意していないため、都度付け加えるのがよいかと思います。
ラベルの色には、Material Designのカラーパレットのうち、300番台のものを使用しました。
Type
Issueで取り組む作業の種別を表すラベル。
- Bug Fix
- バグにより動作しない機能を修正するもの。
- Enhancement
- 改良のために新機能を追加するもの。
- Improvement
- 動作している機能を改良のために修正するもの
- Modification
- 動作している機能をただ修正するもの。
- Optimization
- 動作している機能に最適化を施すもの。
- Security Fix
- セキュリティに問題のある機能を修正するもの。
Status
Issueの状態を表すラベル。
- Available
- 待機中で、作業に取り掛かる予定のもの。（かんばんのToDo）
- In Progress
- 作業中のもの。（かんばんのDoing）
- Completed
- 作業が完了したもの。（かんばんのDone）
- Canceled
- 以前は作業に取り掛かっていたが、中止しているもの。
- Inactive (Abandoned)
- 今後作業に取り掛かる予定がないもの。
- Inactive (Duplicate)
- 他のIssueと重複しており、作業に取り掛かる必要のないもの。
- Inactive (Invalid)
- 内容が不正であることから、作業に取り掛かる必要のないもの。
- Inactive (Won't Fix)
- 作業しないことになったため、作業に取り掛かる必要のないもの。
- Pending
- 何らかの理由で作業が保留になったもの。
Priority
Issueの優先度を表すラベル。
- ASAP
- できる限り早く最優先で取り組み必要のあるもの。
- High
- 優先度の高いもの。
- Medium
- 通常の優先度のもの。
- Low
- 優先度の低いもの。
- Safe
- 余裕があれば取り組むもの。
Effort
Issueに対して想定される作業量を表すラベル。
- Painful
- 膨大な作業量が想定されるもの。
- Heavy
- 比較的多い作業量が想定されるもの。
- Normal
- 平均的な作業量が想定されるもの。
- Light
- 比較的少ない作業量が想定されるもの。
- Effortless
- それほど作業量を必要としないもの。
Feedback
Issueで扱うフィードバックの種類を表すラベル。
- Discussion
- 機能に関する議論を扱うもの。
- Question
- 機能に関する質問を扱うもの。
- Suggestion
- 機能に関する提案を扱うもの。
参考
- How we organize GitHub issues: A simple styleguide for tagging
- Sane GitHub Labels | By Dave Lunny | Medium
- GitHub Labels that are logical, colorful and sensible | SeanTraneSciarrone
おまけ：Statusラベルを使ってGitHub Projectのかんばんを自動化
"Status: Available", "Status: In Progress", "Status: Completed"のラベルを付けた際に、それぞれ"To do", "In progress", "Done"のGitHub Project Columnに追加および移動を行うGitHub Actionsを書きました。
manage_issues_for_project.yml
name: 'Manage Issues for Project'
on:
issues:
types: [labeled]
jobs:
manage-issues-for-project:
runs-on: ubuntu-latest
steps:
- name: Move issues which have a Available label to the project board column called To do
if: github.event.label.name == format('Status{0} Available', ':')
uses: alex-page/github-project-automation-plus@v0.8.1
with:
project: Project Name
column: To do
repo-token: ${{ secrets.GHPROJECT_TOKEN }}
- name: Move issues which have a In Progress label to the project board column called In progress
if: github.event.label.name == format('Status{0} In Progress', ':')
uses: alex-page/github-project-automation-plus@v0.8.1
with:
project: Project Name
column: In progress
repo-token: ${{ secrets.GHPROJECT_TOKEN }}
- name: Move issues which have a Completed label to the project board column called Done
if: github.event.label.name == format('Status{0} Completed', ':')
uses: alex-page/github-project-automation-plus@v0.8.1
with:
project: Project Name
column: Done
repo-token: ${{ secrets.GHPROJECT_TOKEN }}
Secretsの追加は、github-project-automation-plusのREADMEに書いてある通りに行いました。
##参考