GitHubのIssueテンプレートを導入する方法のメモ

f:id:zuckey_17:20181119000127p:plain

個人のプロジェクトを立ち上げるのに、少数ですが複数人でプロジェクトを進めるため、Issueでタスクや機能の詳細を管理しようということになりました。

とはいえ、あまり一緒に仕事を進めたことも多くなく、テンプレートを導入することにしました。

自分でやったことがなかったので、メモとして残しておこうと思います。

必要なことは以下でした。

  • /.github/ISSUE_TEMPLATE以下にmarkdownファイルを置く
  • nameとaboutを入れる

f:id:zuckey_17:20181119000136p:plain

追加したテンプレートは以下でした。

bag_report.md

---
name: Bug report
about: バグを知らせてね

---

## 🐛 Summary

(バグの概要)

## 👀 Steps

(バグの再現手順)

1. Do action
2. Do another action
3. Wrong Behavior !!

## 🆗 Expected

(Closed になるために必要な状態)

## 🚑 Actual

(Issue を作成した時点の状態)

## 📎 Images (optional)

(バグ発生時の画像)

feature.md

---
name: Feature request
about: ワクワクするような新機能リクエスト

---

## 🎉 Goal

(Closed になるために必要な状態)

## 💪 Motivation

(Issue を何故立てたのですか?)
(Issue を作成した背景は?)

## 📖 Reference (optional)

(参考リンクなどあれば)

## 📆 Schedule (optional)

(Closed になるまでのスケジュール)

## 📎 Tasks (optional)

- [ ] Task 1
- [ ] Task 2

task.md

---
name: Task
about: タスクの整理と内容を記す

---

## 💪 タスク

### 📄 資料
+ 

### ✅ 作業
+ [ ] 

### 🚀 完了条件
+

絵文字を入れて楽しげにすることを意識しました。 (今週は短いですが、以上です)