Github 利用 Issue Template 統一開 issue 的內容格式

記得這是在好幾週前發生的事情。有一次在 fb 看到我朋友放一個開 issue 的 link，點開來看那個 issue 的內容都有預設的格式，什麼時候有這麼神奇的功能(我已經這麼落伍了嗎 QQ)，原來叫做 issue template，而且好像 redmine 也有這樣的功能 (stackoverflow 相關問題)，但不管 redmine....，我沒在用 redmine XD，來看看如何在 github 設定你的 issue template 吧！ 步驟都非常的簡單:


(step1)首先在你的 repo 底下你要建立一個新目錄，叫做 .github

mkdir .github && cd .github

(1) .github 這個目錄並不是必要 (畢竟太多東西放在根目錄下還蠻混亂的)，而是如果你希望把這些設定的檔案放在一起的話，推薦遵循放到這個 .github 的資料夾。

(2) 另外你也可以把以下檔案都放到 .github 下:

• CONTRIBUTING.md
• ISSUE_TEMPLATE.md
• PULL_REQUEST_TEMPLATE.md

(step2)新增一個檔案，檔名為 ISSUE_TEMPLATE.md

touch ISSUE_TEMPLATE.md

md 是用 markdown 來表示，內容就隨意編排摟 :P，若你真的不知道怎麼寫可以從這裡找到參考: http://issuetemplate.com/#/ 。

我大概簡單寫得粗糙的版本:

	# 簡單一句話描述你的問題
	## 你的執行環境
	## 瀏覽器是什麼
	## 如何重現這個 issue?
	1. 到 xxx 頁面後點按 xxx 按鈕
	2. click 後顯示lightbox
	3. ....
	## 你預期的結果應該是?
	## 是否知道/猜測問題發生的原因?
	## 有無任何錯誤訊息

view raw ISSUE_TEMPLATE.text hosted with ❤ by GitHub

(step3) 提交你的 issue_template 
在本機做的事情都不算數哦，記得 commit。
接著你在 create issue 的時候就會看到你的 template 了:

你若有興趣，歡迎看看 githun 在 2016/2/18 發的這篇文章: Issue and Pull Request templates。另外發 Pull Request 也可以有 template 哦，檔名就是 PULL_REQUEST_TEMPLATE.md。請多加利用 template 幫助簡化口頭說明流程 XD (但團隊如果有人根本不會用 git 那就另當別論了)