GitHub 項目協作的方法

1 提交到一個分支

https://github.com/pragmaticlearning/single-repo-example 爲例。

如果想擴展 readme.md 文件,需要做的第一件事是創建一個分支,以使得修改時保持獨立。

單擊 branch:master 按鈕,就將創建一個該工程下當前分支的下拉列表和一個文本框,可以輸入現存分支或你想創建的新分支的名字。

可以根據提示創建一個updata_readme分支,點擊進入,接下來可以開始做一些改變。

當前提交僅提交到當前分支下,最後可通過拉請求開始討論所有的修改建議。

2 從分支中創建拉請求

單擊 create pull request 按鈕,選擇在哪兩個分支之間創建一個拉請求。

base分支是想要合併到的對應分支(很可能是主分支),compare分支是希望合併到主分支的那個分支。

3 pull請求合作

pull請求的目的是啓動一個關於所提變更的會話,通常是一個新功能或一個Bug的修復。

創建一個新分支,在上面進行所有的修改直到完成工作。pull請求的目的就像一個雙重檢查,在改變合併到主分支並推送到發佈之前,確保團隊的其他人同意你做出的改變。

如果有一個關於修改的想法但是並不確定它是否是一個好的想法時,考慮創建一個分支開始簡單的工作,然後創建一個pull請求和團隊進行討論。

3.1 pull請求涉及的人

若已經創建了pull請求,並想從團隊的特定成員處得到反饋,可以使用@mention功能來提及他們。

@mention功能需要在pull請求本身或者pull請求的一個描述內,輸入@然後輸出GitHub用戶名。若此人是該項目的所有者或合作者,用戶名將會自動輸入。

3.2 回顧pull請求

若想知道人們在一個項目上做什麼工作,去項目主頁單擊右邊的拉請求選項卡,將看到一個包含所有當前開放的pull請求列表。

當你找到一個想要審查的pull請求時,單擊它來查看pull請求的詳細信息頁面。

3.3 評論pull請求

若收到電子郵件或網頁通知,告知在pull請求中被提到,一定要儘快花時間檢查一下並提供一些有用的反饋信息。

瀏覽pull請求頁面,去評論框,輸入你的反饋,單擊評論按鈕即可。

3.4 給評論添加色彩

GitHub內置有對emoji的支持,或使用gif格式的動畫爲評論添加一些更多的色彩。

3.5 對pull請求做共貢獻

爲做出改變,所需的就是轉到項目主頁並從分支下拉列表中選擇自己的分支。編輯完成後選擇提交。

3.6 測試一個pull請求

有些不能僅從表面上審查的包括實質性代碼更改的pull請求,在贊同之前應該下載庫的一個副本,然後檢查pull請求相關的分支運行自動化測試,以確保能正常通過。

3.7 合併pull請求

當準備合併pull請求時,只需要單擊綠色的 Merge pull request 按鈕,輸入提交的信息,單擊Confirm merge即可完成合並,pull請求會合並關閉。

3.8 誰應該合併pull請求?

其實一般由創建的人進行pull請求的合併是較好的,因爲他們最瞭解自己的更改,對可能造成的一些影響也能最快做出反應。

但是在合併之前應至少得到兩位團隊成員的贊同。

3.9 pull請求通知

若創建了一個pull請求,諸如發表評論、提交或是被@mentioned提及,默認情況下會訂閱該pull請求。這意味着每當有人評論、提交、合併或關閉該pull請求時,都將接到一個通知。

若不再對已經訂閱的pull請求感興趣,單擊Unsabscribe按鈕就會停止接收通知。若被重新@mention則會自動變爲重新訂閱。

若沒有訂閱想要關注的pull請求,則可點擊pull請求的subscribe按鈕,即可開始接收有關pull請求的任何活動通知。

3.10 pull請求的最佳實踐

  • 做每件事情都創建pull請求
    想要修復故障或添加功能都要確保在一個分支上完成這些修改,然後創建一個pull請求以得到輸入內容,最後合併到主分支。
  • 使標題具有描述性
    便於別人能快速理解。
  • 花費一些時間去評論
    可對跟蹤最新的一些進展信息。
  • @mention主要人物
    使得能得到及時、想要的反饋信息。
  • 運行測試
    很多時候僅僅從表面上查看代碼是遠遠不夠的。
  • 贊同一個pull請求要有一個明確的策略
    及時幫助他人完成合並工作。

4 問題

4.1 創建一個新的issue

要創建一個新的問題,單擊問題選項卡,然後點擊 New issue。即可看到下圖界面。

在這裏插入圖片描述

輸入一個描述性的標題,使人快速知道你想要表達的缺陷或功能。

如果知道誰應該複雜這個問題,可以通過單擊No one is assigned 文本標籤右邊的按鈕,從貢獻者下拉列表中選擇此人。

可指定一個時間表milestone,頁面右邊可選擇所有適合的標籤。

完成後單擊底部綠色的 Submit new issue 來創建問題。

4.2 管理問題的時間表

問題的時間表功能通常用於爲問題分配一個特定的衝刺時間(sprint)。

點擊Issues後點擊Milestones按鈕,再點擊 create a milestone 按鈕,用來創建一個新的日程表。

在這裏插入圖片描述

在這裏插入圖片描述
在這裏插入圖片描述
點擊後可選擇到期日期、標題和可選的描述。

完成後點擊 Create milestone 按鈕可看到新的日程添加到你的列表,現在可以編輯這個日程表,關閉、刪除或瀏覽與日程表有關聯的問題列表。

4.3 問題管理標籤

點擊 Issues 再點擊 Labels 可爲項目創建一些自定義標籤,可以編輯(Edit)標題、顏色、刪除(Delete)和創建新標籤(New label + Create)。

4.4 評論問題

對於pull請求:

  • 評論一個問題只需要單擊issue,向下滾動到評論框,輸入你的評論,然後單擊Commont按鈕。
  • 確保每天花一點時間,看看是否有任何新的問題,儘快應對任何@mention ASAP。
  • 隨機使用emoji表情符號和gif動畫給協作過程添加一點樂趣。

4.5 提交中引用問題

若做的提交是和某個問題有關,只需要在提交信息中包括一個 # 符號,後邊是問題的編號,則該提交可顯示在這個問題的歷史記錄中。

4.6 問題的最佳實踐

  • 創建“Bug”和“Feature”標籤
    可以容易地僅看到顯著的錯誤或功能。
  • 如果符合你的工作流程則使用流程表
    如果有外部截止日期或一個基於內部節奏的衝刺,隨意使用日程表指派問題的交付日期。
    如果不使用基於日期的交付,可考慮使用日程表。
  • 分配問題時要小心
    最好由團隊成員的興趣分配工作。
  • 廣泛使用標籤
    可以考慮添加標籤來跟蹤工作狀態,將工作分配給不同的羣體,甚至可用於跟蹤其他有趣的信息。

5 WiKi

在項目整個生命週期的某時刻,READ.md將開始變得太長從而影響使用,此時可考慮使用Wiki。

Wiki是一個非常簡單的內容管理系統,可讓一羣合作者便捷地建立一組相互鏈接的頁面。

通常,GitHub wiki 用於捕獲終端用戶的文檔、開發人員文檔,或者兩者都有,因此相關的所有信息都可通過項目的GitHub頁面訪問。

5.1 開始使用wiki

進入Settings,勾選Wikis。
在這裏插入圖片描述然後點擊‘wiki’,即可看到如下界面。
在這裏插入圖片描述
點擊 create the first page就將看到如下界面。
在這裏插入圖片描述
初始默認爲home,但是可做修改。

可在本文區域設置內容,點擊區域上方的按鈕用於樣式設置,點擊Preview選項卡可進行預覽。

完成內容編輯後,在Edit message文本框中輸入一個簡單的描述,然後單擊Save page進行保存。

5.2 添加且連接到你的wiki頁面

任何時候想要添加一個wiki頁面,只需點擊任何wiki頁面右上角的new page按鈕,將允許向網站添加一個頁面。

完成添加頁面後,它將出現在屏幕右邊的page部分。

複製想要鏈接到的頁面的URL,在想要添加鏈接的頁面點擊右側頁面頂部的Edit按鈕,點擊頂部的鏈接按鈕會彈出對話框,輸入鏈接確定即可。

6 GitHub頁面

wiki在GitHub上是一個用於創建文檔的強大工具,因爲他們位於代碼的右邊,比一個單獨的文件更能保持更新狀態。

然而,有時候想創建一個更用戶化的網站,分享關於自己、組織或項目信息,這就是GitHub頁面。

GitHub頁面是一個功能,允許你創建頁面並擁有GitHub頁面主權。

6.1 爲你的項目創建一個網站

每當在GitHub上創建一個存儲庫,就可以選擇添加GitHub頁面,爲推廣或描述該項目提供一個web頁面。

開始使用GitHub頁面時,單擊settings,向下滾動到GitHub頁面區域,單擊 Automatic page generator 按鈕。

表單允許輸入一個項目名,一個口號,一個主體。

可以在主體區爲使用Markdown的頁面創建一個第一次剪切的內容,並且還有一個添加跟蹤ID的選項,如果希望跟蹤,則使用Google分析來記錄交通信息。

一旦完成了第一頁的輸入,單擊 Continue to layout 按鈕,將進入主題佈局頁面。

點擊右上角的Publish page,網站將被重建,可以在項目頁查看網站。

當爲一個項目創建一個GitHub頁面時,底層會爲你的項目添加一個新的gh-pages分支。

在下拉列表中選擇該分支,會看到一個生成的網站代碼,可使用HTML和CSS對其進行定製。

6.2 爲自己或自己的組織創建一個網站

若想爲自己或自己的組織創建一個網站,需要創建一個名爲username.github.io的項目。

對於個人和組織的GitHub頁面,不是添加一個gh-pages分支,而是使用你的主分支內容建立你的網站。

若想爲組織創建一個網站,去組織的主頁,單擊 +New repository 按鈕。

一定要確保存儲庫名爲 organization_name.github.io,然後勾選 Initial this repository with a README 複選框。

如果你創建這樣一個項目,單擊Setting鏈接,並向下滾動到GitHub頁面部分,將看到已經發佈一個GitHub頁面網站的信息。

如果你瞭解HTML和CSS,可在這裏建立你的網站。如果想利用內置生成器,可以通過單擊 Automatic page generator 按鈕重建這個項目,將會如 GitHub 網站項目頁一樣工作。

參考:《GitHub入門》

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章