はじめに
この記事は、GitLabでissueの作成方法について記載しています。
1. issueとは
GitLab上でのissueとはタスクを指します。
issueを作成する目的は、タスクの明瞭化です。また、実装漏れの削減なども期待できます。
2. issueの作成方法
2.1 作成手順
issueの作成手順です。
- issueを作成するプロジェクトに移動します。
- サイドバーの計画にある「issue」をクリックし、issue一覧画面に移動します。
- 画面上の「新しいissue」ボタンをクリックします。
- タイトルやタイプ、説明を記載していき、作成issueのボタンをクリックすると、作成完了です。
2.2 issue作成時の要点
issue作成時に意識することを項目毎に記載してます。
| 項目 | ポイント |
|---|---|
| タイトル | タイトルを見ただけで、issueの概要が分かるようにしておく |
| タイプ | 実装時などはissue。試験時の不具合のissueを作るときはincidentに変更 |
| テンプレート | テンプレートが用意されている場合、そのテンプレートを選択する。※1 |
| 説明 | このissueは何をするissueなのか、目的とアクションを明確に記載する。作成者=担当者とは限りません |
| 担当者 | 未確定の場合は上司などに相談する。 |
| 期限 | このissueをいつまでに完了させるのかを必ず設定する。 |
| マイルストーン | 各マイルストーンを設定すること。マイルストーンが設定されていない場合は上司などに相談などする。 |
| ラベル | プロジェクトによってはラベルを用意してあるので、そのルールに沿って設定してください。 |
※1.issueのテンプレートがあると、issueに記載するレベルを統一できます。詳細は以下を確認してください。
issueやMR(マージリクエスト)のテンプレート
3. issueの活用方法
issueの具体例を記載しています。
3.1 新規機能開発
以下のxxx,yyy,zzzに実施する内容や注意点などを記載します。
設計書がある場合、設計書へのリンクを張り付けることで設計書をすぐに確認できるようにしています。
# 概要
実装内容を簡潔に箇条書きで記載する。
設計のissueがあれば、必ず紐づけをすること。
**※ 必ずマージリクエストを発行して実装は行うこと**
- [ ] xxxx
- [ ] yyyy
- [ ] zzzz
3.2 バグ修正のissue
バグ修正時のissueの記載例です。
以下の項目内容に沿って、不具合修正に必要な情報などを記載します。
# 概要
プログラムの修正が必要な不具合
- 単一の機能で他の機能には影響がない
- 修正が遅れても、その他のテスト実施が可能
## 不具合内容
| 項目 | 内容 |
| --- | --- |
| 試験要項書 | ××要項書 No.x(issueがあれば紐づけすること) |
| 確認バージョン | 確認バージョン（タグ、コミットハッシュなど） |
| 環境 | 例：Win10 |
| 発生頻度 | 発生頻度(常に、Y/X回) |
## 詳細
不具合の内容を簡潔に書きます。
### 再現方法
再現手順を書く
4. 参考資料
おわりに
今回初めて記事を書いてみました。いざ書いてみると結構難しく感じました。
今後もGitLab関連の記事を記載予定ですので、興味があれば、次の記事なども見ていってください。
GitHubで編集を提案
Discussion