|
原創(chuàng) 2016年06月05日 21:47:38 Github 上的每個(gè)項(xiàng)目倉(cāng)庫(kù)，都有三套基礎(chǔ)設(shè)置可供使用：一個(gè)是通過 Github Pages 機(jī)制建立項(xiàng)目網(wǎng)站,，后面會(huì)介紹的。另外一個(gè)就是每個(gè)項(xiàng)目都可以開自己的 wiki ，作為項(xiàng)目的知識(shí)庫(kù),。第三個(gè)就是咱們今天的主角，事務(wù)卡片（ Issues ）,。很多比較復(fù)雜的項(xiàng)目管理軟件會(huì)把“報(bào) Bug ”,，“提新需求”，“其他討論”,，這些項(xiàng)目相關(guān)的內(nèi)容分成不同的板塊來(lái)進(jìn)行,，在 Github 這里，所有的內(nèi)容就都作為事務(wù)卡片來(lái)統(tǒng)一管理了,。 基本使用 比較詳細(xì)的 Issues 功能介紹,，可以參考官方的 Issue 指南，今天咱們這里會(huì)撿著一些重要的來(lái)說(shuō),。在 How Github Use Github To Build Github 這個(gè)演講中有 Issues 的使用哲學(xué)的一些討論,，非常有啟發(fā)性的。 到項(xiàng)目主頁(yè),，例如 http://github.com/happypeter/coco 頁(yè)面上,，如何來(lái)提一個(gè) Issue 呢？ 上面圖中,，點(diǎn)擊項(xiàng)目主頁(yè)右側(cè)的 Issues 鏈接,，打開的頁(yè)面中的大大的綠按鈕就是新建 Issue 按鈕，點(diǎn)一下就可以看到下圖所示的界面 如上圖,，是一個(gè)簡(jiǎn)單到不能再簡(jiǎn)單的頁(yè)面,，但是很多時(shí)候簡(jiǎn)單的確意味著更加的靈活和強(qiáng)大。1處添加標(biāo)題,，2處詳細(xì)描述一下,，要加圖片？點(diǎn)一下3處的鏈接就行了,。 另外,，對(duì)于開源項(xiàng)目，任何人都有權(quán)利提 Issue 的,，有時(shí)候我有問題需要跟項(xiàng)目擁有者溝通,，就可以提一個(gè) Issue 。 支持 Markdown 語(yǔ)法 在新建 Issue 的界面上可以看到 Markdown Supported （支持 Markdown）的鏈接，點(diǎn)開,，可以看到一篇詳細(xì)的 Markdown 介紹文檔,。 Markdown 是一種標(biāo)記性語(yǔ)言，通過很簡(jiǎn)單的標(biāo)注就可以表示出文本的格式,，這樣在評(píng)論框中寫 markdown ,，點(diǎn)發(fā)布評(píng)論按鈕就可以轉(zhuǎn)換成美觀的 html 來(lái)顯示了。下面來(lái)演示一下它的主要幾個(gè)功能 ,。 可以用 # text 來(lái)把 text 變成一級(jí)標(biāo)題,，也就是 h1 格式。用 **text** 表示粗體,。*text* 表示斜體,。 引用內(nèi)容用 > 打頭就可以了，如下 > 失敗只有一種就是半途而廢,。 無(wú)序列表用 * 第一項(xiàng) * 第二項(xiàng) * 第三項(xiàng) 也可以來(lái)插入代碼塊,，支持語(yǔ)法高亮。例如,，可以像下面這樣為 HTML 代碼添加語(yǔ)法高亮： ```html <!DOCTYPE html> <html> <head> <title>hello</title> </head> <body> <a href="index.html">HOME</a> </body> </html> ``` 發(fā)布后顯示效果如下： 另外也可以插入圖片和鏈接等其他格式,。 Issue 中的一些其他小技巧 還有幾個(gè)小技巧也非常的能提高工作效率。 第一個(gè),，快速引用,。Issue 這里是沒有 reply 按鈕的，如果你想回答具體某個(gè)問題,，可以用鼠標(biāo)選中那段話,，然后，敲 r ,。 這樣這段話就自動(dòng)出現(xiàn)在你的評(píng)論框中了,。 第二個(gè)，拉別人進(jìn)來(lái)討論,。如果你在評(píng)論框中輸入 @happypeter 那么不管我是不是你當(dāng)然項(xiàng)目的參與者,，我都會(huì)收到通知來(lái)進(jìn)來(lái)參加討論。實(shí)際中發(fā)現(xiàn)這個(gè)用的是非常的多,。 第三個(gè),，用版本留言關(guān)閉 Issue。如果有人給我的項(xiàng)目提了個(gè) Bug,，在一個(gè)編號(hào)為20的 Issue （后面簡(jiǎn)寫為 Issue#20） 里。那我寫幾行代碼修復(fù)這個(gè) Bug 之后,，在客戶端作版本時(shí),，只要在版本留言里面寫 fix #20 這樣的字樣，這個(gè)版本同步到 Github 上之后,，這個(gè) Issue#20 就自動(dòng)關(guān)閉了,。 第四個(gè),，如果我在當(dāng)前 Issue#10 的評(píng)論框中寫 #20 就可以自動(dòng)鏈接到 Issue#20 了。同時(shí) Issue#20 那邊也會(huì)顯示出 Issue#10 ,。這種指向和關(guān)聯(lián)的功能在實(shí)用中是非常重要的,。 另外，Issue 上也可以添加標(biāo)簽,，設(shè)置 milestone,，并且把任務(wù)布置給一個(gè)特定的開發(fā)者。 總結(jié) 前面咱們用過很多 Pull Request 的功能了,，其實(shí)一個(gè) PR 和一個(gè) Issue 在很多方面都是一樣的,，所以 Issue 這里介紹的大部分功能都可以在 PR 討論中使用。另外,，Issue 中一般是放一些臨時(shí)性的討論,，最終是要被關(guān)掉的。如果 Issue 里面有一些精華的內(nèi)容,，可以拷貝出來(lái)貼到 wiki 中,，方便大家查閱。
|
|
|
