Microsoft Docs 參與者指南的概觀

歡迎使用 docs.Microsoft.Com (Docs) 參與者指南!

我們有幾個文件集為開放原始碼,託管於 GitHub 上。 持續有越來越多的團隊開始採用此模型。 即使是非完全開放原始碼的文件集,也會有公開的存放庫,可讓您受邀進行提取要求。 它簡化並改善了產品工程師、內容小組和客戶之間的溝通。 公開工作有以下幾個優點:

  • 公開來源存放庫計畫,以取得有關文件所需項目的意見反應。
  • 公開來源存放庫檢閱,以在我們初次發行時發佈最有用的內容。
  • 公開來源存放庫更新,以讓持續改善內容變得更容易。

docs.microsoft.com 上的使用者體驗會直接整合 GitHub (英文) 工作流程,使其變得更加容易。 請從編輯您正在檢閱的文件開始。 或者,透過檢閱新主題建立品質問題來提供協助。

重要

所有發佈至 docs.microsoft.com 的存放庫皆採用 Microsoft 開放原始碼管理辦法 (英文) 或 .NET Foundation 管理辦法 (英文)。 如需詳細資訊,請參閱管理辦法常見問題集 (英文)。 若有任何問題或意見,也可以連絡 opencode@microsoft.comconduct@dotnetfoundation.org

您在公用存放庫中針對文件和程式碼範例所提交的次要修正或釐清,將受到 docs.microsoft.com 使用條款的約束。 如果您不是 Microsoft 的員工,在做出全新或大規模的變更時,系統會在提取要求中產生意見,要求您提交線上版的貢獻授權合約 (CLA)。 您必須先完成填寫線上表單,我們才會檢閱或接受您的提取要求。

對現有文件進行快速編輯

快速編輯可簡化回報並修正文件中小錯誤和遺漏的流程。 無論如何努力,小型的文法和拼字錯誤一定會存在於我們所發佈的文件中。 儘管您可以建立問題來回報錯誤,建立提取要求 (PR) 來解決問題會更加快速且輕鬆。 幾乎每篇文章都會顯示編輯按鈕,如下圖所示。 按一下 [編輯] 按鈕能帶您進入 GitHub 上的來源檔案。

[編輯] 連結的位置

接下來,按一下下圖中顯示的鉛筆圖示來編輯文章。

注意

如果鉛筆圖示是以灰階顯示,則您需要登入您的 GitHub 帳戶,或建立新的帳戶。 在 Web 編輯器中進行變更。 您可以按一下 [預覽變更] 索引標籤來檢查變更的格式設定。

鉛筆圖示的位置

完成變更後,請向下捲動到頁面底部。 為您的 PR 輸入標題和描述,然後按一下 [建議檔案變更],如下圖所示:

建議您的變更

大功告成! 內容小組成員將檢閱並合併您的 PR。 如果您做出較大規模的變更,則可能會收到一些要求變更的意見反應。

GitHub 編輯 UI 會回應您對存放庫的權限。 上述影像適用於不具有目標存放庫寫入權限的參與者。 GitHub 會自動在您的帳戶中建立目標存放庫的分叉。 如果您有目標存放庫的寫入權限,GitHub 會在目標存放庫中建立一個新的分支。 分支名稱的格式為 <GitHubId>-patch-n,並使用您的 GitHub 識別碼,以及針對修補分支的數值識別碼。

我們會使用 PR 來進行所有變更,即使是針對有寫入權限的參與者也是如此。 大多數存放庫都會保護其 master 分支,因此必須將更新提交為 PR。

瀏覽器內編輯體驗,最適合用於小規模或非常態的變更。 如果您做出較大規模的貢獻,或是使用進階 Git 功能 (例如分支管理或進階的合併衝突解決),則需要建立存放庫分叉並在本機工作

檢閱未處理的 PR

您可以透過查看目前未處理的 PR,來在新主題發佈之前閱讀它們。 檢閱需遵循 GitHub 流程 (英文) 的程序。 您可以查看公開存放庫中的建議更新或新文章。 請檢閱它們並新增您的意見。 查看我們的文件存放庫,並針對您感興趣的領域查看未處理的提取要求 (PR)。 任何針對建議更新的社群意見反應,都能為整個社群提供協助。

建立品質問題

我們的文件都是持續進行中的工作。 好的問題有助於我們將工作重點放在社群的最高優先事項上。 您可以提供的細節越多,該問題就越有幫助。 請告訴我們您想要的資訊。 請告訴我們您所使用的搜尋字詞。 如果您無法開始使用,請告訴我們您想要如何開始探索不熟悉的技術。

問題能促進所需項目的相關討論。 內容小組將回應這些問題,提供我們可以新增內容的想法,並徵求您的意見。 當我們建立草稿時,我們會要求您檢閱 PR

深入參與

其他主題可協助您開始有效率地為 Microsoft Docs 做出貢獻。這些主題會說明如何使用 GitHub 存放庫、Markdown 工具,以及 Microsoft Docs 平台所使用的延伸模組。