GitHub Issues 集成介绍

Name: Visual Studio Code
Author: Microsoft

2020 年 5 月 6 日，Alex Ross，@alexr00

在 Visual Studio Code 团队中，我们使用 GitHub issue 来跟踪我们所有的工作。从我们详细的迭代计划到单个 bug，我们都将一切作为 GitHub issue 进行跟踪。鉴于 issue 对我们团队和其他 GitHub 项目的重要性，我们希望将 GitHub issue 集成到 VS Code 中。此项新增功能补充了我们一年多前宣布的 GitHub Pull Request 工作。从 VS Code 1.45 版本开始，这项将 issue 和源代码更紧密结合的新支持将在 GitHub Pull Requests and Issues 扩展（以前名为 GitHub Pull Requests）中提供。

我们的集成方法

Issue 和 Pull Request 通常是相辅相成的，因此将它们包含在同一个 GitHub Pull Requests and Issues 扩展中是合乎逻辑的一步，因为 issue 和 Pull Request 都需要许多相同的 GitHub API。我们不希望将 GitHub 功能直接添加到 VS Code 核心编辑器中，因为有许多源代码控制选项。相反，当我们检测到用户的开放存储库使用 GitHub 时，我们将推荐此扩展。通过使用我们自己的扩展 API，我们确保 API 具有扩展作者所需的功能，并且其他存储库提供商可以实现类似的集成。

重要的是我们不应规定过于具体的工作流程。相反，我们的目标是以灵活的方式将 issue 引入内部开发循环。例如，在代码注释中为 issue 提供更多上下文是该目标的一部分，但将完整的 issue 管理添加到 VS Code 中则不太合适。我们不希望重新发明 GitHub 已经做得很好的 UI。我们确实希望建立尚不存在的连接。

代码上下文中的 Issue

在源代码中链接到 issue 是我们工作流程的正常部分，尤其是在有些逻辑难以理解或有 //TODO 注释需要处理时。如果您在 VS Code 存储库中搜索 issue 引用，您会看到许多提及的 issue。虽然链接提供了更多信息的指针，但要真正了解更多信息，您需要离开编辑器。现在，通过悬停获取此 issue 上下文，您无需中断流程即可了解更多信息。

Issue Hover

Issue 悬停适用于完整的 issue URL、issue 评论 URL、通过编号引用的 issue (#1234) 以及通过 owner/repository#1234 引用的 issue（例如 Microsoft/vscode#1234）。我们还经常在代码库中引用用户。VS Code 拟议 API 有许多开发者引用，以明确谁负责这些提案。

User Hover

Issue 上下文通常在提交消息中需要，以引用提交解决的 issue，在源代码文件中，以及在 Markdown 中（例如更新日志）。为了轻松添加此上下文，我们为 issue 和用户添加了完成建议。在 Git 提交文本框中，您可以使用 githubIssues.issueCompletionFormatScm 设置来格式化您的 issue 完成。在 Markdown 文件中，issue 以 Markdown 链接的形式完成，在其他文件中，issue 以简单的 issue 编号 (#1234) 完成。

Completion Suggestions

可能的 issue 列表可通过设置 githubIssues.queries 进行配置，因此如果您跨多个存储库工作，则可以包含这些 issue 的查询。查询使用 GitHub 搜索语法。用户列表包括当前开放存储库中的协作者。

Issue Queries

从任何地方创建 issue

当我们在处理某些源代码时在 VS Code 中发现 bug 时，我们会创建一个 issue 并将其分配给该区域的所有者。或者，如果 bug 的发现者也是所有者，我们通常会留下一个 //TODO 注释作为提醒，以便稍后再处理。当您有许多贡献者时，在整个代码库中散布 //TODO 很难跟踪（尽管可以肯定地说我们都这样做过），但创建 issue 并在 //TODO 中引用它是可跟踪的。为了减少在您深入源代码时创建 issue 的障碍和上下文丢失，有几种创建 issue 的新方法

从 //TODO 注释（可通过 githubIssues.createIssueTriggers 配置）中，您可以在不离开 VS Code 的情况下创建和分配 issue。

Create Issue from TODO

通过选择，您可以使用GitHub Issues: Create Issue from Selection命令快速创建 issue，并带有指向其源源代码的永久链接。如果您只需要指向某些代码的指针，您还可以使用GitHub Issues: Copy GitHub Permalink命令。最后，如果终端中有失败信息，您只需将输出复制到剪贴板并使用GitHub Issues: Create Issue from Clipboard创建 issue。

处理 issue

常见的工作流程是查看您的 issue，选择一个进行处理，创建一个分支进行工作，进行一些提交，然后通过 Pull Request 将您的更改合并回主分支。从新的Issues视图中，您可以准确地完成此操作。

Work on an Issue

为了适应更多的工作流程，您可以配置几个选项。如果您的工作流程不涉及创建主题分支，您可以使用 githubIssues.useBranchForIssues 禁用分支创建。如果您的分支有不同的命名方案，您可以使用 githubIssues.issueBranchTitle 设置。Issues视图中列出的 issue 可以配置为使用 githubIssues.queries 使用自定义查询。

想了解更多信息？

您可以观看 Sana Ajani（@sana_ajani）和 Burke Holland（@burkeholland）在 GitHub Satellite 上关于“每个 GitHub 用户都应该了解的 VS Code”的演讲。

您还可以阅读使用 GitHub 主题，其中更详细地描述了 VS Code 的 GitHub 集成。

未来展望

目前，这些功能中的大多数仅支持存储库克隆（而非分支），因此还有更多工作要做以支持该功能和其他用例。我们希望收到您对这个扩展的反馈，因此请随时在扩展的 repo 中的 issue 中给我们留下建议！

编码愉快！

Alex Ross，VS Code 开发者 @alexr00