从Fork到Merge使用GitVSCode参与office-docs-powershell文档共建的进阶工作流【免费下载链接】office-docs-powershellPowerShell Reference for Office Products - Short URL: aka.ms/office-powershell项目地址: https://gitcode.com/gh_mirrors/of/office-docs-powershelloffice-docs-powershell 是 Office 产品Teams、Exchange、Skype、Whiteboard 等PowerShell Cmdlet 参考文档的官方仓库内容最终会发布到微软技术站点并直接服务于命令行中的Get-Help帮助系统。对于经常参与文档贡献的协作者来说网页端编辑已无法满足需求——使用Git VSCode 的本地工作流从 Fork 到 Merge 的完整链路能让你批量编辑、本地校验、多机协作是参与 office-docs-powershell 文档共建的进阶方式 为什么选择 Git VSCode 进阶工作流对比项网页端快速编辑Git VSCode 本地工作流适用场景偶发的小改动批量更新、新增 Cmdlet 文档本地校验❌ 不支持✅ 可用 platyPS 校验 schema分支管理❌✅ 多分支并行多机同步❌✅ push / pull 自由切换网页端只需点击“Edit this file”即可提交小改动但当你需要用 repo_docs/NEW_CMDLETS.md 中的流程批量生成并撰写 Cmdlet 文档时本地 Git 工作流才是正解。第 1 步一键 Fork 仓库到你的账号打开仓库页面点击右上角的Fork按钮仓库的完整副本就会出现在你的账号下——主仓库即“上游Upstream”你的副本即“下游Fork”。Fork 完成后可通过右上角头像菜单进入Your profile → Repositories确认你的 Fork 已列出。建议定期将 Fork 与上游同步避免长期脱节。第 2 步克隆 Fork 到本地开发机在 VSCode 中按 Ctrl 打开内置终端Git Bash克隆你 Fork 的仓库git clone https://gitcode.com/gh_mirrors/of/office-docs-powershell 克隆的是你自己的 ForkURL 中包含你的账号而不是上游主仓库。三端协作关系如下图所示本地仓库 ↔ 你的 Fork ↔ 上游主仓库。第 3 步配置 upstream 远程保持 Fork 同步添加上游远程并拉取最新内容这一步是让后续合并不冲突的关键git remote add upstream https://gitcode.com/gh_mirrors/of/office-docs-powershell git fetch upstream第 4 步创建工作分支隔离每次改动为每个改动任务创建独立分支-b参数会在创建的同时切换过去git checkout -b fix-get-mailbox-docs第 5 步用 VSCode 编辑 PowerShell Cmdlet Markdown分屏预览VSCode 右上角的侧边预览图标可让 Markdown 源码与渲染效果并排显示所见即所得 遵循 platyPS schemaCmdlet 参考文档的标题结构有严格约定任何偏差都会导致 PR 校验失败或Get-Help报错每句一行Git 按行比对差异每个句子或概念单独占一行段落间空一行善用现有内容大量参数描述在各 Cmdlet 间通用参照同产品的既有文档撰写即可各产品线文档的存放位置速查产品线目录Exchangeexchange/exchange-ps/exchange/Teamsteams/teams-ps/teams/Skypeskype/skype-ps/skype/Office Web Appsofficewebapps/officewebapps-ps/officewebapps/Whiteboardwhiteboard/whiteboard-ps/whiteboard/新增 Cmdlet 文档时仓库提供了自动化工具用 platyPS 的New-MarkdownHelp从 PowerShell 会话导出 Markdown 骨架再手动补全描述。详细步骤见仓库内的 repo_docs/NEW_CMDLETS.md 和 repo_docs/UPDATE_CMDLETS.md。第 6 步提交并推送到你的 Forkgit add . git commit -m 更新 Get-Mailbox 文档补充新参数说明 git push origin fix-get-mailbox-docs第 7 步合并上游 master提前化解冲突提交 Pull Request 前先切回工作分支合并上游主分支。注意方向把上游 master 合并进你的分支而不是反过来这样上游维护者合并时才会顺畅git fetch upstream git merge upstream/master如有冲突在 VSCode 中直接处理解决后再次推送即可。第 8 步创建 Pull Request等待审核合并回到仓库页面点击New Pull Request→ 选择compare across forks→ 选定上游分支与你的工作分支 → 填写标题与描述可 提醒评审人→ 点击Create pull request。首次提交时CLA 机器人会自动检查贡献者许可协议按提示完成一次即可。维护者审核通过后PR 被 Merge 进 master你的内容随后发布上线——用户执行Get-Help Cmdlet时看到的正是你写下的文字 成果验证与更多贡献资源合并发布后Cmdlet 文档会出现在官方文档站点并同步到 PowerShell 的Get-Help在线帮助完整进阶流程原文repo_docs/ADVANCED.md新增 / 更新 Cmdlet 文档指南repo_docs/NEW_CMDLETS.md、repo_docs/UPDATE_CMDLETS.md常见问题解答repo_docs/FAQ.md各文档负责人信息ContentOwners.txt文档自动化工具Cmdlet 文档更新器tools/office-cmdlet-updater/项目遵循微软开源行为准则贡献前请阅读根目录的 LICENSE 与 SECURITY.md至此你已经掌握了从 Fork 到 Merge 的完整闭环Fork → Clone → 建分支 → 编辑校验 → 推送 → 合并上游 → Pull Request → 发布。祝你的第一篇文档顺利合入【免费下载链接】office-docs-powershellPowerShell Reference for Office Products - Short URL: aka.ms/office-powershell项目地址: https://gitcode.com/gh_mirrors/of/office-docs-powershell创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考