Microsoft Learn 的貢獻基本概念

已完成

有一些詞彙可協助您了解及完成貢獻程序。 您不需要知道在幕後發生的一切,但是參與工作方式的一般概觀可協助您了解流程運作的原由。

Microsoft Learn 和 GitHub 基本概念

Microsoft Learn 包含數千個發行項、訓練課程模組、網頁等等,這些項目需要由許多參與者儲存和定期存取。 Microsoft Learn 會使用 GitHub 來儲存大部分的內容。 GitHub 是一個使用 Git 的平台,這是分散式版本控制系統,用來儲存專案,並協助在具有不同專案目標和時間表的多個專案關係人之間進行共同作業。 Git 和 GitHub 軟體可讓您與相同專案上的其他參與者平行作業,甚至可能是同時在完全相同的內容上作業,也不會無意間干擾其他人的工作。

內容會儲存在 GitHub 上裝載的 Git 存放庫 (repos) 檔案中。 存放庫是包含專案檔案和檔案修訂歷程記錄的儲存體單位。 存放庫可以是公用或私人,而 Microsoft Learn 是由兩者混合而成。 設定 GitHub 帳戶之後,任何人都可以參與公用存放庫。 私人存放庫僅適用於身為 Microsoft 員工或已獲得特殊權限的參與者。

對儲存在 GitHub 存放庫中的 Microsoft Learn 內容進行編輯

針對任何專案,GitHub 會裝載主要存放庫和任何分支。 分支是參與者為自己的工作所做的主要存放庫複本。 分支是 GitHub 保護已發佈內容的方式之一。 GitHub 不會直接編輯主要存放庫中的即時、已發佈分支中的內容,而是為您的分支擷取該內容的快照,以便您可以在該處進行變更。

GitHub 存放庫包含一或多個分支。 分支是儲存體單位,其中包含組成專案內容集的檔案和資料夾。 所有存放庫,無論是主要存放庫或是分支,都包含預設分支 (通常名為主要),以及一或多個要合併回預設分支的分支。 預設分支可作為專案的目前版本和「單一事實來源」。 它是存放庫中所有其他分支的建立來源。

顯示 GitHub 存放庫中主分支之外工作分支的圖表。在工作分支中進行變更,然後合併回主分支。

在公用存放庫中編輯文件文章是從觸控按鈕開始,但是在幕後發生了許多事。 當您啟動瀏覽器型編輯流程時,會建立存放庫分支 (如果您還沒有分支),並用於變更。 您會在分支的分支內編輯,稍後會合併到主要存放庫的即時分支,讓變更可供所有人使用。

建立提取要求

此合併如何發生? 您必須告訴 GitHub - 特別是主要存放庫的擁有者和文章作者 - 您的編輯已完成,並且準備好檢閱、發佈,讓全世界查看! 若要這樣做,您要建立及提交提取要求

提取要求 (PR) 是一項提案,可讓您的變更從您正在使用的分支中的分支,合併到即時存放庫的預設主要分支。 當您在公用存放庫中工作時,提取要求一律會由人類檢閱者檢閱,然後再合併。 也可能有一些自動化檢查,例如合併相容性和組建驗證。 完成這些檢閱並解決任何問題之後,您的變更將會合併到即時分支,並且可在 Microsoft Learn 上取得!

對文件進行次要貢獻的工作流程

總而言之,您要在 GitHub 中使用 Web 編輯器對 Microsoft 文件進行小型變更時,請遵循下列一般步驟:

Microsoft Learn 上的開放原始碼文件貢獻的貢獻流程圖表。

  1. 當您在瀏覽器中開啟要編輯的檔案時,系統會自動為您建立公用存放庫的分支。 也會建立分支中的分支,通常稱為修補程式分支。
  2. 對檔案進行變更。
  3. 建立提取要求,以建議檢閱和合併您的變更。
  4. 您的 PR 必須解決任何問題,並通過所有檢閱。
  5. 您的 PR 會合併到即時存放庫的主分支,而您的變更會在 Microsoft Learn 上發佈。

接下來,讓我們更仔細地查看每個步驟,以了解如何執行。