GitHub提供內(nèi)置的協(xié)作和溝通工具,使開發(fā)者能夠與社區(qū)進行密切互動。本文將幫助選擇適合需求的交流工具??梢詣?chuàng)建并參與問題(Issues)、拉取請求(Pull Requests)以及 GitHub Discussions,來參與不同類型的對話。
一、簡介
1、GitHub Issues
GitHub Issues適用于討論項目的具體細(xì)節(jié),例如 Bug 報告、計劃的改進或反饋。
- 與特定倉庫相關(guān),通常有明確的負(fù)責(zé)人
- 通常作為 GitHub 的錯誤跟蹤系統(tǒng)
2、拉取請求(Pull Requests)
允許提出具體的更改,或直接對其他人的建議進行評論。
- 特定于倉庫
- 用于審查和合并更改
3、GitHub Discussions
類似于論壇,適合進行開放式的討論,尤其是在合作非常重要的情況下。
- 可能跨越多個倉庫
- 提供了一個超越代碼庫的協(xié)作體驗,可以集思廣益,創(chuàng)建社區(qū)知識庫
- 沒有明確的負(fù)責(zé)人,也不會直接導(dǎo)致可操作的任務(wù)
二、應(yīng)該使用哪種討論工具
1、GitHub Issues適用于以下場景:
- 跟蹤任務(wù)、增強功能和漏洞
- 提交錯誤報告
- 分享對特定功能的反饋
- 向項目維護者詢問與倉庫文件相關(guān)的問題
問題示例:
例如一位用戶在 GitHub 文檔的開源倉庫中創(chuàng)建一個問題,報告中文版頂部橫幅的藍(lán)色背景讓文字無法辨認(rèn),并提出了使用不同背景色的修復(fù)建議。隨后參與者進行了討論,最終達(dá)成共識并提交了包含修復(fù)的拉取請求。
2、拉取請求適用于以下場景:
- 修復(fù)倉庫中的拼寫錯誤
- 提交對倉庫的更改
- 修復(fù)代碼中的問題
- 對其他人的更改建議進行評論
拉取請求示例:
在開源文檔倉庫中,用戶發(fā)現(xiàn)拼寫錯誤并創(chuàng)建了一個拉取請求,修復(fù)了該問題。在拉取請求的“對話”選項卡中,作者解釋了創(chuàng)建此請求的原因。
在“文件更改”選項卡中,展示了修復(fù)內(nèi)容。項目維護員審查了拉取請求并合并了它。
3、GitHub Discussions 適用于以下場景:
- 提出不一定與倉庫中的特定文件相關(guān)的問題
- 向團隊或協(xié)作者分享消息
- 發(fā)起或參與開放式討論
- 向社區(qū)發(fā)布公告
GitHub Discussions示例:
在 GitHub 文檔的開源倉庫中,社區(qū)維護員發(fā)起了一次“歡迎使用 GitHub 文檔討論”的討論帖,歡迎社區(qū)成員并請大家自我介紹。這個帖子為訪客和參與者創(chuàng)造了一個友好的氛圍,并闡明了團隊如何希望與社區(qū)合作。
三、如何使用GitHub Copilot獲取上下文
如果需要更多上下文或?qū)μ囟ㄗh題或討論的澄清,可以使用 GitHub Copilot 快速獲得見解,理解復(fù)雜的討論內(nèi)容,確保與項目目標(biāo)的一致性,從而促進社區(qū)協(xié)作與知識共享。
如何詢問關(guān)于議題或討論的問題:
1、在 GitHub 頁面右上角,點擊搜索欄旁的 GitHub Copilot 圖標(biāo)。
2、單擊“新建對話”按鈕,輸入問題,并在消息中包含相關(guān)的 URL,例如:
Explain https://github.com/monalisa/octokit/issues/1 Summarize https://github.com/monalisa/octokit/discussions/4 Recommend next steps for https://github.com/monalisa/octokit/issues/2 What are the acceptance criteria for ISSUE URL? What are the main points made by PERSON in DISCUSSION URL?
3、(可選)可以點擊文本框中的“X”以阻止 Copilot 繼續(xù)響應(yīng)。