共用方式為


參與撰寫 PowerShell 文件

感謝您對 PowerShell 的支援!

參與者指南是一系列文章,描述我們用來在 Microsoft 撰寫文件的工具和過程。 其中一些指南涵蓋發布於 learn.microsoft.com 的任何檔案集的通用資訊。 其他指南是專門為PowerShell撰寫文件的指南。

我們的集中式 參與者指南提供常見文章。 這裡提供PowerShell特定指南。

參與方式

有兩種方式可以參與。 這兩項貢獻對我們都是有價值的。

  • 提出問題 可協助我們找出檔中的問題和差距。 有時這些問題很難解決,需要更多的調查和研究。 問題程式可讓我們就問題進行交談,並制定令人滿意的解決方案。

  • 遞交拉取請求 以新增或變更內容是一個更複雜的過程。 下列資訊概述將內容提交至檔的工具、程序和標準。

準備做出貢獻

要貢獻文件需要 GitHub 帳戶。 使用下列檢查清單來安裝和設定您需要參與的工具。

  1. 註冊 GitHub
  2. 安裝 Git 和 Markdown 工具
  3. 安裝 Docs 撰寫套件
  4. 安裝 Posh-Git - 不需要但建議
  5. 建立及設定本機 Git 儲存庫
  6. 檢閱 Git 和 GitHub 基本概念

開始撰寫檔

有兩種方式可以參與文件的變更:

  1. 快速編輯現有檔 - 次要修正、修正錯字或小新增
  2. 文件的完整 GitHub 工作流程 - 大幅變更、多個版本、新增或變更圖片,或撰寫新文章

此外,請閱讀集中參與者指南的撰寫要領章節。 另一個優秀的資源是 Microsoft寫作風格指南

learn.microsoft.com 使用條款涵蓋對公用存放庫中檔和程式代碼範例的次要修正或釐清。

當您進行重大變更時,請使用完整的 GitHub 工作流程。 如果您不是Microsoft的員工,我們的 PR 驗證系統會在提取要求中新增批注,要求您簽署在線貢獻許可協定 (CLA)。 您必須先完成此步驟,我們才能檢閱或接受您的提取要求。 只有在您第一次在儲存庫中提交 PR 時,才需要簽署 CLA。 每次參與新存放庫時,系統可能會要求您簽署 CLA。

行為規範

發佈至 Microsoft Learn 的所有存放庫都遵守 Microsoft開放原始碼規範.NET Foundation 行為規範。 如需詳細資訊,請參閱 行為規範常見問題

後續步驟

下列文章涵蓋PowerShell檔專屬的資訊。 在集中貢獻者指南中與指導方針重疊的部分,我們會明確指出這些規則在 PowerShell 內容中的差異。

請檢閱下列文件:

其他資源