🔥
【Github初心者向け】issueの使い方をマスターしよう
はじめに
今回は、Githubのissueの基礎的な使い方やテンプレートの作成方法について解説します。
この記事を学習することで、issueの基本的な使い方をマスターできます。
GitHub Issuesとは
作業を計画、議論、追跡するためにリポジトリで作成できる項目です。
開発中のプログラムにバグがあった場合や新しい機能を追加する必要がある場合に、issueを作成する必要があります。
issueの機能を実際に使ってみよう
下記の動画がとても参考になります。
issueの作成、LabelやMilestoneの作成、コミットとissueの紐付けなど基礎的なことを学ぶことができます。
実際のプロジェクトではどのようなLabelを設定しているか
基本的には下記のようなラベルを設定することが多い気がします。
・feature：新規機能追加
・bugfix：不具合対応
・wantfix：修正要望
・refactor：リファクタリングやTODO消化
・pending：一時保留 / バグが再現しないなど
・QA：作業にあたってQA中の項目がある場合
issue templateの作り方
下記の記事がとても参考になります。
実際にプロジェクトではどのようにissue templateを作成しているか
下記はバグ報告用のissue templateです。
バグ報告の目的は不具合の発生内容を開発チームに正しく理解してもらうことにあります。
バグ報告のサンプル例は下記の記事が参考になります。
bug_report.md
## 発生した事象
<!-- こちらに不具合の概要を記載してください -->
- コメント
## 期待した結果
<!-- 期待する動作について明確かつ簡潔に説明してください -->
## 再現手順
<!-- 再現手順を具体的に記述してください -->
1. '...' をクリックします
2. '...' をクリックします
## 実行環境
- 端末：
- ユーザーID:
- ユーザー名:
- アドレス:
- その他情報:
## 補足資料
### スクリーンショット
<!-- 可能な限り事象が確認できるスクリーンショットを添付してください -->
<img width="300" src="" >
### ログ
<!-- APIとの疎通に問題がある場合などはログを記入してください -->
Discussion