若要變更內容,請從您的派生版本提交拉取請求(PR)。 必須先檢閱拉取請求,才能合併。 為了獲得最佳結果,請先檢閱 編輯檢查清單 ,再提交提取要求。
使用 git 分支
PowerShell-Docs 的預設分支是 main 分支。 在發佈之前,工作分支中所做的變更會合併到 main 分支中。 該 main 分支會在每個工作日下午 3:00(太平洋時間)合併到 live 分支中。 分支 live 包含發佈至 learn.microsoft.com的內容。
開始任何變更之前,請在 PowerShell-Docs 存放庫的本機複本中建立工作分支。 在本機工作時,請務必先同步處理本機存放庫,再建立工作分支。 工作分支應該從分支的 main up-to日期複本建立。
所有拉取請求都應該以main分支為目標。 請勿將變更提交至 live 分支。 分支中 main 所做的變更會合併至 live,並覆寫對 live所做的任何變更。
讓拉取請求流程更適合每個人
如果您的PR能夠更簡單且更專注,它就能更快被檢閱和合併。
避免拉取請求更新大量檔案或包含不相關的變更
避免建立包含不相關變更的PR。 將現有文章的次要更新與新文章或主要重寫分開。 在個別的工作分支中處理這些變更。
大量變更會建立具有大量已變更檔案的PR。 將您的PR限制為最多50個已變更的檔案。 大型PR難以檢閱,而且更容易包含錯誤。
重新命名或刪除檔案
當您重新命名或刪除檔案時,必須有與 PR 相關聯的問題。 此問題必須討論重新命名或刪除檔案的需求。
避免混合新增內容或變更與檔案重新命名和刪除。 您重新命名或刪除的任何檔案都必須新增至適當的重新導向檔案。 可能的話,請更新連結至已重新命名或刪除內容的任何檔案,包括任何 TOC 檔案。
避免編輯存放庫組態檔
避免修改存放庫組態檔。 請盡可能限制您對 Markdown 內容檔案和內容所需的任何支援圖像檔所做的變更。
對存放庫組態檔的修改不正確,可能會中斷組建、引入弱點或輔助功能問題,或違反組織標準。 存放庫組態檔是符合其中一或多個模式的任何檔案:
*.yml.github/**.localization-config.openpublishing*LICENSE*reference/docfx.jsonreference/mapping/**tests/**ThirdPartyNoticestools/**
為了安全性和安全性,請勿變更這些檔案。 如果您認為其中一個檔案應該變更, 請提出問題。 維護人員將問題分類之後,他們會進行適當的變更。
使用PR範本
當您建立PR時,會自動為您插入PR主體中的範本。 看起來像這樣:
# PR Summary
<!--
Delete this comment block and summarize your changes and list
related issues here. For example:
This changes fixes problem X in the documentation for Y.
- Fixes #1234
- Resolves #1235
-->
## PR Checklist
<!--
These items are mandatory. For your PR to be reviewed and merged,
ensure you have followed these steps. As you complete the steps,
check each box by replacing the space between the brackets with an
x or by clicking on the box in the UI after your PR is submitted.
-->
- [ ] **Descriptive Title:** This PR's title is a synopsis of the changes it proposes.
- [ ] **Summary:** This PR's summary describes the scope and intent of the change.
- [ ] **Contributor's Guide:** I have read the [contributors guide][contrib].
- [ ] **Style:** This PR adheres to the [style guide][style].
<!--
If your PR is a work in progress, please mark it as a draft or
prefix it with "(WIP)" or "WIP:"
This helps us understand whether or not your PR is ready to review.
-->
[contrib]: /powershell/scripting/community/contributing/overview
[style]: /powershell/scripting/community/contributing/powershell-style-guide
在 [PR 摘要] 區段中,撰寫變更的簡短摘要,並依其問題編號列出任何相關問題,例如 #1234。 如果您的 PR 修正或解決問題,請使用 GitHub 的 自動封鎖 功能,以便在合併 PR 時自動關閉問題。
檢查「PR 檢查清單」區段中的項目,並在完成每項時勾選。 您必須遵循指示,並檢查團隊的每個項目,以批准您的PR。
如果您的 PR 是進行中的工作,請將其設定為 草稿模式,或在 PR 標題前加上 WIP。
期望批注
提交PR之後,Bot會批注您的PR。 批注提供資源,並為後續過程設定期望。 我們可能會定期更新此批注,因此請一律檢閱批注,即使這不是您的第一個貢獻也一樣。
Docs PR 驗證服務
Docs PR 驗證服務是 GitHub 應用程式,可在變更上執行驗證規則。 您必須修正驗證服務所報告的任何錯誤或警告。
下列步驟概述驗證行為:
您提交 PR。
在 GitHub 批注中,指出存放庫上已啟用「檢查」的狀態。 在此範例中,已啟用兩項檢查:「認可驗證」和「OpenPublishing.Build」:
即使認可驗證失敗,組建仍可通過。
選取 [詳細數據 ] 以取得詳細資訊。 [ 詳細數據 ] 頁面會顯示所有失敗的驗證檢查,並包含如何修正問題的相關信息。
驗證成功時,會將下列批注新增至 PR:
備註
如果您是外部參與者(不是Microsoft員工),則無法存取詳細的組建報表或預覽連結。
檢閱PR時,系統可能會要求您進行變更或修正驗證警告訊息。 PowerShell-Docs 小組可協助您了解驗證錯誤和編輯需求。
GitHub 工作流程
針對您的變更執行數個不同的 GitHub Actions,以驗證並提供內容給您和檢閱者。
檢查清單驗證
如果您的 PR 不在草稿模式中,且未加上WIP前綴時,GitHub Action 會檢查您的 PR,以確認您已在 PR 範本的檢查清單中選取每個項目。 維護人員在完成檢查清單之前,不會檢閱或合併您的PR。 檢查清單項目是必須的。
授權驗證
如果您的 PR 以 live 分支為目標或修改任何存放庫組態檔,GitHub Action 會檢查您的許可權,以確認您有權提交這些變更。
只有存放庫管理員有權以分支為目標 live 或修改存放庫組態檔。
版本化內容變更報告
如果您的PR包含新增、移除或修改任何版本化內容,GitHub Action 會分析您的變更,並撰寫報告以摘要說明對版本化內容所做的變更類型。
此報告會顯示您是否有其他版本的檔案需要在此PR中更新。
若要查找 PR 版本化內容報告:
- 選取 PR 頁面上的 [檢查] 索引標籤。
- 從作業清單中選取 [報告] 作業。
- 選取 “...”右上方的按鈕。
- 選取 [檢視作業摘要]。