探索 GitHub 流程

已完成

GitHub 是在專案中啟用共同作業的最佳工具。 GitHub 流程是建議用於 GitHub 的分支型工作流程。

注意

若要實作 GitHub 流程,您需要 GitHub 帳戶和存放庫。 請參閱「註冊 GitHub」和「建立存放庫」。

提示

您可以透過 GitHub Web 介面、命令列、GitHub CLIGitHub Desktop,完成 GitHub 流程的所有步驟。

第一個步驟是在您的存放庫中建立分支,以便在作業時不會影響預設分支,以及讓共同作業者有機會檢閱您的工作。

如需詳細資訊,請參閱「在存放庫內建立和刪除分支」。

Screenshot of a branching model representing the branch creation.

對存放庫進行任何想要的變更。 如果發生錯誤,您可以還原或推送額外的變更來修正錯誤。

認可並推送您的變更至分支,以將工作備份至遠端儲存體,並為每個認可提供描述性訊息。 每個認可都應該包含獨立且完整的變更,以便若您採用不同的方法時可以輕鬆還原。

在您的專案中進行共同作業的任何人都可以看到您的工作、回答問題,以及提出建議或貢獻。 請繼續建立、認可和推送變更至分支,直到您準備好要求意見反應為止。

提示

您可以為每個變更建立個別分支,讓檢閱者輕鬆提供意見反應,或讓您輕鬆了解差異。

準備好之後,您可以建立提取要求,要求共同作業者就您的變更提供意見反應。 請參閱「建立提取要求」。

提取要求檢閱是共同作業中最重要的功能之一。 在合併變更之前,您可以要求同儕和小組核准。 此外,您可以將工作標示為草稿,以備您在完成變更之前想要提早獲得意見反應或建議。

Screenshot of a branching model representing an open a pull request.

盡可能描述提取要求,以及使用建議的變更和您要解決的問題。 您可以新增影像、連結、相關問題或任何資訊來記錄您的變更,並協助檢閱者了解 PR,而不需開啟每個檔案。 請參閱「基本撰寫和格式語法」和「將提取要求連結至問題」。

Screenshot of open a pull request representation with description field, related issue and a checklist template.

另一個改善 PR 品質與文件並向檢閱者明確指出內容的方式,就是使用註解工作階段區域。 此外,您也可以 @mention 或向特定人員或小組要求檢閱。

Screenshot of pull request comment field.

提取要求還有其他設定,例如在建立提取要求時自動要求特定小組或使用者進行檢閱,或在提取要求時執行檢查。 如需詳細資訊,請參閱「關於狀態檢查」和「關於受保護的分支」。

檢閱者的註解和檢查驗證之後,變更應該準備好可以進行合併,而且檢閱者可以核准提取要求。 請參閱「合併提取要求」。

如果有任何衝突,GitHub 會通知您解決這些問題。 「處理合併衝突」。

Screenshot of a branching model representing the branch merge.

成功合併提取要求之後,就不需要留下遠端分支。 您可以刪除分支,防止其他人意外使用舊版分支。 如需詳細資訊,請參閱「在提取要求中刪除和還原分支」。

注意

GitHub 會保留認可和合併歷程記錄,以防您需要復原或還原提取要求。