GitHub flow
介紹
GitHub 流是一個(gè)輕量級的、基于分支的工作流。GitHub 流對每個(gè)人都很有用,而不僅僅是開發(fā)人員。例如,在 GitHub,我們使用 GitHub 流程作為站點(diǎn)策略、文檔和路線圖。
先決條件
若要遵循 GitHub 流,你需要一個(gè) GitHub 帳戶和一個(gè)存儲(chǔ)庫。有關(guān)如何創(chuàng)建帳戶的信息,請參閱"注冊 GitHub"。有關(guān)如何創(chuàng)建存儲(chǔ)庫的信息,請參閱"創(chuàng)建存儲(chǔ)庫"。有關(guān)如何查找要參與的現(xiàn)有存儲(chǔ)庫的信息,請參閱"在 GitHub 上查找為開源做出貢獻(xiàn)的方法"。
遵循 GitHub 流
提示:您可以通過 GitHub Web 界面、命令行和 GitHub?CLI 或 GitHub?Desktop 完成?GitHub?流的所有步驟。
創(chuàng)建分支
在存儲(chǔ)庫中創(chuàng)建分支。簡短的描述性分支名稱使您的協(xié)作者能夠一目了然地查看正在進(jìn)行的工作。例如,或 .更多信息請參閱"在存儲(chǔ)庫中創(chuàng)建和刪除分支"。increase-test-timeout
add-code-of-conduct
通過創(chuàng)建分支,可以創(chuàng)建一個(gè)空間,以便在不影響默認(rèn)分支的情況下工作。此外,您還可以讓協(xié)作者有機(jī)會(huì)查看您的工作。
進(jìn)行更改
在分支上,對存儲(chǔ)庫進(jìn)行任何所需的更改。有關(guān)更多信息,請參閱"創(chuàng)建新文件"、"編輯文件"、"重命名文件"、"將文件移動(dòng)到新位置"或"刪除存儲(chǔ)庫中的文件"。
您的分支機(jī)構(gòu)是進(jìn)行更改的安全場所。如果您犯了錯(cuò)誤,可以還原更改或推送其他更改來修復(fù)錯(cuò)誤。在合并分支之前,您的更改不會(huì)最終出現(xiàn)在默認(rèn)分支上。
提交更改并將其推送到分支。為每個(gè)提交提供一條描述性消息,以幫助你和未來的參與者了解提交包含哪些更改。例如,或 .fix typo
increase rate limit
理想情況下,每個(gè)提交都包含一個(gè)隔離的完整更改。這樣,如果您決定采用不同的方法,可以輕松還原更改。例如,如果要重命名變量并添加一些測試,請將變量重命名放在一個(gè)提交中,將測試放在另一個(gè)提交中。稍后,如果要保留測試但還原變量重命名,則可以還原包含變量重命名的特定提交。如果將變量重命名和測試放在同一個(gè)提交中,或者將變量重命名分散到多個(gè)提交中,則還原更改將花費(fèi)更多精力。
通過提交和推送更改,您可以將工作備份到遠(yuǎn)程存儲(chǔ)。這意味著您可以從任何設(shè)備訪問您的作品。這也意味著您的協(xié)作者可以看到您的工作,回答問題并提出建議或貢獻(xiàn)。
繼續(xù)進(jìn)行更改、提交更改并將其推送到分支,直到準(zhǔn)備好請求反饋。
提示:為每組不相關(guān)的更改創(chuàng)建一個(gè)單獨(dú)的分支。這使得審閱者更容易提供反饋。它還使您和未來的協(xié)作者更容易理解更改并還原或構(gòu)建它們。此外,如果一組更改中存在延遲,則其他更改也不會(huì)延遲。
創(chuàng)建拉取請求
創(chuàng)建拉取請求,向協(xié)作者詢問有關(guān)您更改的反饋。拉取請求審核非常有價(jià)值,以至于某些存儲(chǔ)庫需要經(jīng)過審批審核才能合并拉取請求。如果您在完成更改之前需要早期反饋或建議,則可以將拉取請求標(biāo)記為草稿。更多信息請參閱"創(chuàng)建拉取請求"。
創(chuàng)建拉取請求時(shí),請包括更改的摘要以及它們解決的問題。您可以包括圖像、鏈接和表格來幫助傳達(dá)此信息。如果拉取請求解決了某個(gè)問題,請鏈接該問題,以便問題利益干系人了解拉取請求,反之亦然。如果使用關(guān)鍵字進(jìn)行鏈接,則在拉取請求合并時(shí),問題將自動(dòng)關(guān)閉。更多信息請參閱"基本編寫和格式設(shè)置語法"和"將拉取請求鏈接到問題"。

除了填寫拉取請求的正文外,您還可以向拉取請求的特定行添加注釋,以向?qū)忛喺呙鞔_指出某些內(nèi)容。

您的存儲(chǔ)庫可以配置為在創(chuàng)建拉取請求時(shí)自動(dòng)請求特定團(tuán)隊(duì)或用戶的審閱。您還可以手動(dòng)@mention或請求特定人員或團(tuán)隊(duì)進(jìn)行審核。
如果您的存儲(chǔ)庫已將檢查配置為在拉取請求上運(yùn)行,您將看到在拉取請求上失敗的所有檢查。這有助于您在合并分支之前捕獲錯(cuò)誤。更多信息請參閱"關(guān)于狀態(tài)檢查"。
解決審核意見
審稿人應(yīng)留下問題、意見和建議。審閱者可以對整個(gè)拉取請求進(jìn)行注釋,也可以向特定行添加注釋。您和審閱者可以插入圖像或代碼建議來闡明注釋。更多信息請參閱"查看拉取請求中的更改"。
您可以繼續(xù)提交和推送更改以響應(yīng)評論。您的拉取請求將自動(dòng)更新。
合并您的拉取請求
拉取請求獲得批準(zhǔn)后,合并拉取請求。這將自動(dòng)合并您的分支,以便您的更改顯示在默認(rèn)分支上。GitHub 在拉取請求中保留注釋和提交的歷史記錄,以幫助將來的貢獻(xiàn)者了解您的更改。更多信息請參閱"合并拉取請求"。
GitHub 會(huì)告訴您拉取請求是否存在沖突,必須在合并之前解決這些沖突。更多信息請參閱"解決合并沖突"。
如果拉取請求不滿足某些要求,則分支保護(hù)設(shè)置可能會(huì)阻止合并。例如,您需要一定數(shù)量的審批審核或來自特定團(tuán)隊(duì)的審核審核。更多信息請參閱"關(guān)于受保護(hù)的分支"。
刪除您的分支
合并拉取請求后,刪除分支。這表示分支上的工作已完成,并防止您或其他人意外使用舊分支。更多信息請參閱"刪除和還原拉取請求中的分支"。
不用擔(dān)心丟失信息。您的拉取請求和提交歷史記錄不會(huì)被刪除。如果需要,您始終可以還原已刪除的分支或還原拉取請求。

原文網(wǎng)址
https://docs.github.com/cn/get-started/quickstart/github-flow