共用方式為

管理提取要求

本文說明如何在 PowerShell-Docs 存放庫中管理提取要求。 本文旨在作為 PowerShell-Docs 小組成員的工作輔助工具。 我們在這裡發布這項資訊，以提供公眾貢獻者程序上的透明度。

最佳做法

  • 要求檢閱。 提交PR的人員不應該在沒有對等檢閱的情況下合併PR。
  • 提交PR時，請指派對等檢閱者。 及早指定任務可讓審稿人更快回覆編輯意見。
  • 使用批注來描述所提交變更的性質。 例如，如果變更是次要的，請說明變更，而且您不需要完整的技術檢閱。 請確認@mention審核者。
  • 使用批注建議功能，讓作者更容易接受建議的變更。 如需詳細資訊，請參閱 檢閱提取要求中建議的變更。

PR 流程步驟

  1. 寫入器：建立PR
    • 填寫 PR範本
    • 連結PR所解決的任何問題
    • 使用 GitHub 的 自動關閉 功能來關閉問題
    • 在檢查清單中逐一查看並勾選每個項目
  2. 作者：指派同儕檢閱者
  3. 檢閱者：校訂和批注（視需要）
  4. 作者：納入審查意見反饋
  5. 兩者：檢閱預覽渲染
  6. 兩者：檢閱驗證報告 - 修正警告和錯誤
  7. 檢閱者：將檢閱標示為「已核准」
  8. 存放庫維護者：合併PR

內容檢閱者檢查清單

如需更完整的清單，請參閱 編輯檢查 清單。

  • 文法、樣式、簡潔、技術精確度的校訂。
  • 確定範例仍適用於目標版本
  • 檢查預覽渲染
  • 檢查元數據 - ms.date、移除 ms.assetid、確定必要字段
  • 驗證 Markdown 正確性
    • 請參閱內容特定格式規則的樣式指南
  • 重新組織範例，如下所示：
    • 簡介段落
    • 程式碼與輸出
    • 程式代碼的詳細說明（必要時）
  • 檢查超連結是否有正確性
    • 取代或移除TechNet/MSDN 連結
    • 確保重新導向至目標的次數最少
    • 確定 HTTPS
    • 正確的鏈接類型
      • 本機檔案的檔案連結
      • docset 外部檔案的 URL 連結
    • 從 URL 中移除地區資訊
    • 簡化指向learn.microsoft.com的URL
  • 確認所有版本中的內容正確無誤

分支合併程式

分支 main 是唯一應該合併至 live的分支。 在合併到 main 之前，應該先將短期（工作）分支的合併縮減。

合併自/至 release-branch（釋出分支） 主要 即時
工作分支 壓縮並合併 壓縮並合併 不允許
release-branch — 合併 不允許
主要 重新定基 — 合併

PR 合併檢查清單

  • 內容檢閱完成
  • 變更的正確目標分支
  • 沒有合併衝突
  • 所有驗證和建置步驟都通過
    • 應修正警告和建議（請參閱例外狀況 注意事項 ）
    • 沒有中斷的連結
    • 檢查清單動作已執行並通過
    • 如果已觸發 授權 檢查，則會通過
  • 根據表格合併

註釋

可以忽略下列警告：

Can't find service name for `<version>/<modulepath>/About/About.md`

Metadata with following name(s) are not allowed to be set in YAML header, or as file level
metadata in docfx.json, or as global metadata in docfx.json: `locale`. They are generated by
Docs platform, so the values set in these 3 places will be ignored. Please remove them from all
3 places to resolve the warning.

合併PR時，會變更目標分支的HEAD。 任何以先前 HEAD 為基礎的開放式 PR 現在都已過時。 專案維護者有必要的權限來覆寫合併警告，並在 GitHub 上合併過時的 PR。 如果先前合併的PR未觸及相同的檔案，合併過期的PR是安全的。

若要更新PR，請選取 [ 更新分支] 按鈕。 選擇 [使用重新基底更新] 選項。 如需詳細資訊，請參閱 更新拉取請求分支。

發佈至即時

定期將分支中累積的 main 變更發佈至實時網站。

  • 每個工作日，分支 main 會在 PST 下午 3 點合併至 live。
  • 分支 main 應在任何重大變更之後合併至 live 。
    • 50 個以上的檔案變更
    • 合併發行分支之後
    • 存放庫或檔案集組態的變更（docfx.json、OPS 組態、組建腳稿等）
    • 重新導向檔案的變更
    • TOC 的變更
    • 合併「專案」分支之後（內容重新排列、大量更新等）
  • Last updated on