Microsoft Docs 參與者指南的概觀

歡迎使用Microsoft Docs參與者指南!

我們有幾個開放原始碼的 Microsoft 文件集,由 GitHub 代管。 並非所有檔集都完全開放原始碼,但許多檔組都有公開存放庫,您可以在其中透過提取要求 (PR) 來建議變更。 此開放原始碼方法可簡化並改善產品工程師、內容小組和客戶之間的通訊,並具有其他優點:

  • 開啟中的開放原始碼 存放庫計畫 ,以取得最需要檔的意見反應。
  • 開放原始碼存放庫 會在開放版中檢閱 ,以在第一個版本中發佈最有用的內容。
  • 開放原始碼存放庫 會在開啟中更新 ,讓您更輕鬆地持續改善內容。

Microsoft Docs上的使用者體驗會直接整合GitHub工作流程,使其更容易。 從 編輯您要檢視的檔開始。 或透過 檢閱新主題建立品質問題來協助

重要

發佈至Microsoft Docs的所有存放庫都已採用Microsoft 開放原始碼管理辦法或.NET Foundation 管理辦法。 如需詳細資訊,請參閱管理辦法常見問題集 \(英文\)。 請連絡 opencode@microsoft.comconduct@dotnetfoundation.org 與任何問題或留言。

您在公用存放庫中針對文件和程式碼範例所提交的次要修正或釐清,將受到 docs.microsoft.com 使用條款的約束。 新的或重大變更會在 PR 中產生批註,要求您提交線上貢獻授權合約, (CLA) 如果您不是 Microsoft 員工。 我們需要您完成線上表單,才能檢閱或接受您的 PR。

快速編輯檔

快速編輯可簡化報告和修正檔中小型錯誤和省略的程式。 即便我們非常努力,發佈的文件中仍不免存在少許文法和拼字錯誤。 雖然您可以建立問題來回報錯誤,但建立 PR 以修正問題的速度較快且更容易,但當選項可用時。

  1. 某些文件頁面允許您直接在瀏覽器中編輯內容。 如果是這樣,您將會看到如下 [編輯] 按鈕。 選擇 [編輯 (或同等當地語系化) 按鈕會帶您前往 GitHub 上的原始程式檔。

    編輯文章連結的位置。

    如果 [ 編輯 ] 按鈕不存在,表示內容不會開放給公開參與。 例如,某些頁面是從程式碼) 中的內嵌檔產生 (,而且必須在所屬專案中編輯。

  2. 選取鉛筆圖示以編輯文章。 如果鉛筆圖示顯示為灰色,表示您必須登入您的 GitHub 帳戶或建立新帳戶。

    分叉和編輯鉛筆圖示的位置。

  3. 在網頁編輯器中編輯檔案。 選擇 [預覽] 索引標籤,以檢查變更的格式設定。

  4. 當您完成編輯時,請捲動至頁面底部。 在 [ 建議變更 ] 區域中,輸入標題,並選擇性地輸入變更的描述。 標題將是認可訊息的第一行。 選取 [建議變更 ] 以認可您的變更:

    建議並認可檔案變更。

  5. 既然您已提出並認可變更,您必須要求存放庫的擁有者將變更「提取」至其存放庫。 這是使用稱為「提取要求」 (PR) 。 當您選取 [ 建議變更] 時,會顯示類似下列的新頁面:

    比較變更並建立提取要求。

    選取 [建立提取要求]。 接下來,輸入 PR 的標題和描述,然後選取 [建立提取要求]。 如果您不熟悉 GitHub,請參閱 關於提取要求 以取得詳細資訊。

  6. 就這麼簡單! 內容小組成員會檢閱您的 PR,並在核准時加以合併。 您可能會收到要求變更的意見反應。

GitHub 編輯 UI 會回應您對存放庫的權限。 上述映射適用于沒有目標存放庫寫入權限的參與者。 GitHub 會自動在您的帳戶中建立目標存放庫的分叉。 新建立的分叉名稱預設為表單 GitHubUsername/RepositoryName 。 如果您有目標存放庫的寫入權限,例如分支,GitHub 會在目標存放庫中建立新的分支。 分支名稱具有預設表單patch- n,使用修補程式分支的數值識別碼。

我們針對所有變更使用 PR,甚至是具有寫入權限的參與者。 大部分的存放庫都會保護預設分支,以便將更新提交為 PR。

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

注意

大部分的當地語系化檔都無法透過 GitHub 編輯或提供意見反應。 若要提供當地語系化內容的意見反應,請使用 aka.ms/DocSiteLocFeedback提供的電子郵件範本。

檢閱未處理的 PR

您可以藉由檢查開啟的 PR 佇列,先閱讀新主題再發佈。 檢閱需遵循 GitHub 流程 \(英文\) 的程序。 您可以查看公開存放庫中的建議更新或新文章。 請檢閱它們並新增您的意見。 查看我們的任何 Docs 存放庫,並檢查您感興趣的區域開啟的 PR。 任何針對建議更新的社群意見反應,都能為整個社群提供協助。

建立品質問題

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

許多 Microsoft 的檔頁面在頁面底部都有 [ 意見 反應] 區段,您可以選擇離開 產品意見 反應或 內容意見反應 ,以追蹤該文章特有的問題。

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

深入參與

本指南中的其他主題可協助您開始更有生產力地參與Microsoft Docs。其說明如何使用Microsoft Docs平臺中使用的 GitHub 存放庫、Markdown 工具和擴充功能。