在 VS Code 中使用 GitHub：Pull Requests、Issues 与 GitHub Repositories 完整指南

文档教程【免费下载链接】vscode-docsPublic documentation for Visual Studio Code项目地址https://gitcode.com/gh_mirrors/vs/vscode-docs点击查看免费下载导读本文是 Visual Studio CodeVS Code官方文档中 Work with GitHub in VS Code 的深度详解系统讲解如何在 VS Code 中完成 GitHub 认证、克隆与推送、创建与评审 Pull Request、管理 Issue以及在不克隆仓库的情况下通过 GitHub Repositories 扩展直接浏览和编辑远程仓库。读完本文你将能够根据协作目标选择正确的集成方式独立完成从分支开发、提交、推送、发起 PR 到评审合并的完整 GitHub 协作闭环并掌握githubPullRequests.queries、githubIssues.createIssueTriggers、githubIssues.issueBranchTitle等关键设置项的配置方法。选择 GitHub 工作流VS Code 为与 GitHub 协作提供了多种内置与扩展能力基础的 GitHub 认证和 Git 操作已内置于 VS Code扩展则补充了 Pull Request、Issue 以及虚拟仓库工作流。根据你要达成的目标可选择以下集成方式目标能力前提条件克隆、拉取、推送仓库与远程操作VS Code 内置 Git 支持安装 Git 并在提示时登录创建与评审 Pull Request、管理 IssueGitHub Pull Requests and Issues 扩展安装扩展并登录不克隆即可浏览与编辑远程仓库GitHub Repositories 扩展安装扩展并登录终端、构建与调试工作流需要其他环境GitHub Pull Requests and Issues 与 GitHub Repositories 是两个相互独立的扩展只安装支持你工作流的那个即可避免功能重叠与不必要的资源占用。前置条件对于本地检出local checkout工作流需要安装 Git下载并安装 Git。配置提交身份按照 源代码管理快速上手 中的前置条件配置user.name与user.email。注意登录 GitHub 并不会替代 Git 的提交身份配置——若缺少该配置提交会失败并提示Make sure you configure your user.name and user.email in git详见 故障排查 的相关章节。拥有托管账号要发布更改、创建 Pull Request 或管理 Issue还需要注册一个 GitHub 托管账号。需要特别说明的是登录并不等于对所有仓库拥有写权限。如果你无法向目标项目推送正确的做法是先创建 fork分叉在自己的 fork 中工作再向原项目发起 Pull Request。登录 GitHub 完成 Git 操作执行 Git 认证操作并不需要安装任何扩展。当你克隆私有仓库或向 GitHub 仓库推送时VS Code 会弹出登录提示。跟随浏览器提示完成认证后返回 VS Code 即可。针对 GitHub Enterprise ServerVS Code 支持使用个人访问令牌Personal Access Token, PAT认证。使用方法为取消浏览器登录提示直到 VS Code 询问令牌然后粘贴令牌完成认证。其他认证方式请参阅 GitHub 官方文档中关于 GitHub 认证方法的说明。开始使用 GitHub Pull Requests and Issues 扩展安装 GitHub Pull Requests and Issues 扩展后需要先登录才能使用 Pull Request 与 Issue 功能在活动栏Activity Bar中选择 GitHub 图标。选择Sign In跟随浏览器提示完成认证。认证完成后返回 VS Code。如果浏览器完成认证后没有自动跳转回 VS Code可以手动添加授权令牌在浏览器窗口中复制你的授权令牌authorization token。在 VS Code 状态栏Status Bar中选择Signing in to github.com...。粘贴令牌并按Enter完成登录。设置仓库克隆仓库你可以通过以下两种方式从 GitHub 搜索并克隆仓库在命令面板kb(workbench.action.showCommands)即CtrlShiftP/CmdShiftP中运行Git: Clone命令在没有打开文件夹时点击源代码管理Source Control视图中的Clone Repository按钮。在 GitHub 仓库下拉列表中可以过滤并选择要克隆到本地的仓库。克隆完成后Git 会自动创建一个指向原始仓库的远程remote名为origin。关于克隆、添加远程、发布到 GitHub 以及 fetch/pull/push/sync 的更多细节请参阅 仓库与远程操作。补充说明来自 仓库与远程操作克隆公共仓库通常不需要登录克隆私有仓库时则会提示登录。克隆后 VS Code 会询问本地存放文件夹并可在新窗口中打开该仓库。克隆并不授予写权限要推送更改需使用你有写权限的仓库或先创建 fork。打开来自其他来源的代码前请留意 Workspace Trust 提示。本地仓库尚未连接远程时可用Publish to GitHub命令直接在 GitHub 上创建仓库命名仓库、选择公开或私有、选择初始提交包含的文件VS Code 会创建远程仓库、添加为 remote 并推送提交。注意Publish to GitHub创建的是新托管仓库而Publish Branch是将分支上传到已有远程并设置上游upstream若托管仓库已存在应将其添加为远程而非重复创建。关于 fetch仅下载不合并、pull拉取并整合、push上传本地提交与 sync先拉后推的选择逻辑可参考 仓库与远程操作 中的操作对比表。[!NOTE] 如果你希望不将仓库内容克隆到本地就直接工作可以安装 GitHub Repositories 扩展直接在 GitHub 上浏览和编辑详见后文 GitHub Repositories 扩展 一节。Pull Requests使用 GitHub Pull Requests and Issues 扩展的Pull Requests视图来创建或评审提议的更改。创建 Pull Requests打开本地仓库创建一个分支并提交你的更改。在命令面板kb(workbench.action.showCommands)中运行GitHub Pull Requests: Create Pull Request或在Pull Requests视图中选择Create Pull Request。在Create视图中选择接收更改的基础仓库base repository和基础分支base branch填写标题title和描述description。如果仓库配置了 Pull Request 模板扩展会自动填充该模板。选择Create。如果你的分支尚未发布系统会提示你选择可以推送的远程例如你的 fork。创建后扩展会以Review Mode评审模式打开该 Pull Request。在请求评审之前请先核对目标分支和变更文件是否正确。创建完成后可以使用操作栏添加Assignees指派人员、Reviewers评审人、Labels标签或Milestone里程碑。对于未完成的工作可从Create按钮菜单选择Create Draft创建草稿 PR。其他选项如Auto-Merge自动合并取决于仓库支持与你的权限。评审 Pull Requests在Pull Requests视图中选择一个 Pull Request打开其Description描述。要在本地检查和测试代码请先提交或暂存stash当前更改然后选择Checkout。扩展会检出 Pull Request 分支并进入Review Mode。此时Changes in Pull Request视图会列出变更文件和提交。选择文件查看 diff 并添加评论。使用Open File打开工作文件。在该检出工作流中本地导航、IntelliSense 和编辑功能均可用。从 Pull RequestDescription中提交你的评论或评审结论。批准approve与合并merge操作取决于你的权限和仓库规则。完成后选择Exit Review Mode返回之前的分支。切换前请保留好本地编辑内容。[!TIP] 分支切换前若有未提交的更改Git 可能阻止切换以避免丢失工作可先提交或使用 stash详见 分支与 Worktree。自定义 Pull Request 列表通过配置githubPullRequests.queries设置可以控制Pull Requests视图显示哪些 Pull Request。查询使用 GitHub 搜索语法。例如在设置 JSON 文件中添加以下配置{ githubPullRequests.queries: [ { label: Assigned To Me, query: is:open assignee:${user} } ] }其中${user}会被替换为当前登录用户is:open表示只显示打开状态的 PRassignee:${user}表示指派给当前用户的 PR。你可以按团队需要配置多组查询每组label会在视图中显示为独立的分组标题。使用 AI 辅助 Pull RequestsAI 辅助是可选功能。要生成 Pull Request 标题和描述点击标题字段旁的 sparkle✨图标然后审阅生成的文本即可。该操作使用chat.utilitySmallModel设置配置的 utility 模型而不是聊天或 Agent 会话中选用的模型。相关配置与要求请参阅 为工具类任务更换模型。此外你也可以在创建 Pull Request 之前通过 GitHub Copilot 对提议的更改进行 AI 代码评审在 GitHub Pull Request 视图中选择Code Review即可。Issues创建 IssuesIssue 可以通过以下方式创建点击Issues视图中的按钮运行GitHub Issues: Create Issue from Selection与GitHub Issues: Create Issue from Clipboard命令通过针对 TODO 注释的 Code Action 创建。创建 Issue 时可以使用默认描述也可以点击右上角的Edit Description铅笔图标打开编辑器编辑 Issue 正文。Code Action 的触发词可通过GitHub Issues: Create Issue TriggersgithubIssues.createIssueTriggers设置配置默认触发词如下githubIssues.createIssueTriggers: [ TODO, todo, BUG, FIXME, ISSUE, HACK ]你可以按项目约定增删触发词例如加入WIP或XXX等团队常用标记。处理 Issues在Issues视图中你可以查看自己的 Issue 并开始处理。默认情况下当你通过Start Working on Issue上下文菜单项开始处理某个 Issue 时扩展会为你自动创建一个分支如下图所示的状态栏提示。状态栏还会显示当前活动 Issue。点击该条目会弹出 Issue 操作列表例如在 GitHub 网站上打开该 Issue或直接为其创建 Pull Request。相关设置项GitHub Issues: Issue Branch TitlegithubIssues.issueBranchTitle配置自动创建分支时的分支名称格式。GitHub Issues: Use Branch For IssuesgithubIssues.useBranchForIssues如果你的工作流不涉及创建分支或希望每次都提示输入分支名可以关闭此设置以跳过自动建分支步骤。[!TIP] 深入了解分支管理有助于理解分支切换、管理以及如何组织开发工作。处理完 Issue 并准备提交更改时Source Control视图中的提交消息输入框会自动填充一条消息其格式可通过GitHub Issues: Working Issue Format SCMgithubIssues.workingIssueFormatScm设置配置。编辑器集成GitHub Pull Requests and Issues 扩展在编辑过程中也会提供用户与 Issue 信息。Hovers悬停提示将鼠标悬停在提及的用户名上可查看该用户的详情悬停在 Issue 引用上可查看对应 Issue 的详情。Suggestions建议在编辑器或提交消息输入框中输入可获得用户建议输入#可获得 Issue 建议。可通过githubIssues.queries设置选择哪些 Issue 出现在建议中查询同样使用 GitHub 搜索语法。若要从建议中排除某些语言可配置githubIssues.ignoreCompletionTrigger针对 Issue或githubIssues.ignoreUserCompletionTrigger针对用户。两者都接受语言标识符。例如{ githubIssues.ignoreCompletionTrigger: [ python ] }GitHub Repositories 扩展GitHub Repositories 扩展允许你在不克隆到本地的情况下浏览、搜索、编辑并向远程 GitHub 仓库提交更改。该工作流适合查看源码或对文件做小改动。需要注意这是**虚拟工作区virtual workspace**而非本地检出。要运行终端命令、构建或调试项目请继续在本地克隆或其他开发环境中工作。打开仓库安装 GitHub Repositories 扩展后通过以下方式打开仓库在命令面板kb(workbench.action.showCommands)中运行GitHub Repositories: Open Repository...命令点击状态栏左下角的 Remote 指示器。运行Open Repository命令后可选择从 GitHub 打开仓库、从 GitHub 打开 Pull Request或重新打开之前连接过的仓库。如果此前未登录 GitHub系统会提示你用 GitHub 账号进行认证。你可以直接输入仓库 URL也可以在文本框中搜索 GitHub 上的仓库。选择仓库或 Pull Request 后VS Code 会重新加载窗口并在资源管理器Explorer视图中显示仓库内容。你可以像在本地克隆中一样打开文件支持语法高亮与括号匹配、进行编辑并提交更改。与本地仓库工作流的一个区别是使用 GitHub Repositories 扩展提交更改时更改会直接推送到远程仓库类似于在 GitHub Web 界面中操作。另一个特性是每次打开仓库或分支都会获得 GitHub 上最新的源码无需像本地仓库那样手动 pull 刷新。GitHub Repositories 扩展还支持查看甚至提交 LFSLarge File System跟踪的文件而无需在本地安装 Git LFS。只需将要跟踪的文件类型加入.gitattributes文件然后通过 Source Control 视图直接提交到 GitHub 即可。切换分支点击状态栏中的分支指示器即可切换分支。无需先 stash 未提交的更改因为扩展会记住你的更改并在返回该分支时自动重新应用。Remote Explorer通过活动栏上的 Remote Explorer 可以快速重新打开远程仓库。该视图会显示之前打开过的仓库和分支。创建 Pull Requests如果你的工作流使用 Pull Request 而非直接提交可以从 Source Control 视图创建新 PR系统会提示你提供标题并创建新分支。创建 PR 后可以使用 GitHub Pull Requests and Issues 扩展评审、编辑和合并该 PR方法见上文 Pull Requests 一节。虚拟文件系统由于仓库文件不在本地机器上GitHub Repositories 扩展会在内存中创建虚拟文件系统virtual file system以便查看文件内容和进行编辑。使用虚拟文件系统意味着某些假定本地文件的操作和扩展将不可用或功能受限。任务tasks、调试debugging和集成终端integrated terminals等功能不会启用你可以通过 Remote 指示器悬停提示中的features are not available链接了解虚拟文件系统的支持程度。扩展作者可以参考 Virtual Workspaces 扩展作者指南了解如何在虚拟文件系统与虚拟工作区中运行扩展。Continue Working On有时你需要切换到支持本地文件系统与完整语言、开发工具的开发环境中继续工作。GitHub Repositories 扩展可以方便地实现创建 GitHub codespace需安装 GitHub Codespaces 扩展将仓库克隆到本地将仓库克隆到 Docker 容器需安装 Docker 和 Microsoft Container Tools 扩展。要切换开发环境在命令面板kb(workbench.action.showCommands)中运行Continue Working On命令或点击状态栏中的 Remote 指示器。如果你使用的是基于浏览器的编辑器Continue Working On命令提供在本地或 GitHub Codespaces 云端环境中打开仓库的选项。第一次在存在未提交更改时使用Continue Working On可以选择通过Cloud Changes将编辑带到所选开发环境。Cloud Changes 将你的待处理更改存储在 VS Code 用于 Settings Sync 的同一服务上。这些更改在应用到目标开发环境后会从该服务中删除。如果你选择不携带未提交更改继续之后仍可通过配置workbench.cloudChanges.continueOn: prompt更改这一偏好。如果你的待处理更改未能自动应用到目标开发环境可以使用Cloud Changes: Show Cloud Changes命令查看、管理并删除已存储的更改。后续步骤当分支包含相互冲突的更改时解决合并冲突。当远程操作失败时排查认证与推送失败问题。为并行处理多个 Pull Request管理分支与 worktree。相关仓库文档还可继续阅读源代码管理概览、仓库与远程操作、暂存与提交更改 以及 源代码管理快速上手。赞分享文档教程【免费下载链接】vscode-docsPublic documentation for Visual Studio Code项目地址https://gitcode.com/gh_mirrors/vs/vscode-docs点击查看免费下载相关推荐GitHub代码审查终极指南Pull Requests vs Merge Requests vs Code Reviews详解GitHub代码审查终极指南Pull Requests vs Merge Requests vs Code Reviews详解 在开源软件开发中 代码审查文档知识库MCP SEP 流程迁移从 GitHub Issues 到 Pull Requests 的完整指南MCP SEP 流程迁移从 GitHub Issues 到 Pull Requests 的完整指南 导读 Model Context ProtocolMCP人工智能AI Agent工具调用使用 Remote Repositories 扩展在 VS Code 中无需克隆即可远程浏览、编辑与提交 GitHub 仓库使用 Remote Repositories 扩展在 VS Code 中无需克隆即可远程浏览、编辑与提交 GitHub 仓库 本文围绕 VS Code 官方博客文档教程上一篇CloudCompare在实际工程中的应用案例测绘、地质与建筑行业下一篇React Native Firebase 应用内消息In-App Messaging模块实战指南安装配置、消息展示控制与源码解析创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考