🏷️
GitHubのLabelについて
GitHubのLabelについて
「OSS開発をやりたいなぁ」
昔からの憧れもあり、OSSのことがよく分からい状態でOSS開発を始めてしまいました。
開始してみると分からないことばかりです。
基本的なことから調べて理解します。
Issueを書いてみたものの右側の列に何を設定したらよいか迷います。
まずは「Labels」に何を設定したらいいか考えてみました。
Labelがあるメリット
IssueやPull requestを書くと一覧にタイトルが表示されます。
Labelを付けておくとタイトルの横にLabelが表示されます。
- 一覧を見た時にどのLabelが設定されているかわかる
- Labelでフィルタリングできる
- 複数のLabelも設定できる
ヘッダー部のLabelをクリックするとフィルタリングするLabelを選べます。
デフォルトのLabelについて
GitHubでRepositoryを作成すると以下のようなDefaultのLabelがあります。
公式ドキュメントを確認すると、各Labelが説明されています。
| Label | 説明 |
|---|---|
| bug | 予期しない問題または意図しない行動を示します |
| documentation | ドキュメンテーションに改善や追加が必要であることを示します |
| duplicate | 似た issue、pull request、ディスカッションを示します |
| enhancement | 新しい機能のリクエスト |
| good first issue | 初回のコントリビューターに適したissueを示します |
| help wanted | メンテナーが Issue もしくはプルリクエストに助けを求めていることを示します |
| invalid | issue、pull request、ディスカッションが関係なくなっていることを示します |
| question | issue、pull request、ディスカッションにさらに情報が必要であることを示します |
| wontfix | issue、pull request、ディスカッションに対する作業が続けられないことを示します |
Labelを編集する
読めば「なるほど」と思える内容です。
しかし、GitHubに慣れていない人でもissueを書きやすくしたいので、Labelを編集することにしました。
「Issues」から「Labels」をクリックすると「Labels」の一覧に移動します。
URLのリポジトリ名の後ろに「labels」を付けても移動できます。
https://github.com/posita33/（リポジトリ名）/labels
「New label」か既存のLabelの「Edit」をクリックします。
以下の項目を設定し、「Save changes」をクリックします。
| 項目 | 説明 |
|---|---|
| Label name | ラベル名 |
| Desctiption | 説明 |
| カラー | ラベルの色（更新ボタンでランダムに色を設定） |
「Label name」や「Desctiption」には絵文字を使用できます。
OSS開発を開始したばかりなので使いそうなLabelを分かりやすくなるように追加・編集・削除してみました。
| Label | 説明 | |
|---|---|---|
| - | 🌱開発中 | 開発中 |
| enhancement | ⛏新機能リクエスト | 新機能をお願いしたい |
| - | 🍔その他 | ラベルに当てはまらない（新しいLabelの検討） |
| bug | 🐞バグ・問題報告 | 問題が発生した |
| question | 💬質問 | 記述内容に質問がある |
| document | 📝ドキュメント | ドキュメントの追加と編集 |
該当するLabelに当てはまらない場合は、「🍔その他」に設定してもらいます。
「🍔その他」が発生した時に新しいLabelを検討します。
参照URL
Discussion