跳至主要内容

为您的团队或项目规划和跟踪工作

使用 GitHub 的计划和跟踪工具在团队或项目中管理工作的要点。

简介

您可以使用 GitHub 仓库、议题、项目及其他工具来计划和跟踪工作,无论是个人项目还是跨职能团队。

在本指南中,您将学习如何创建并设置仓库以便与多人协作,创建议题模板和表单,打开议题并拆分工作,以及建立项目来组织和跟踪议题。

创建仓库

当启动新项目、计划或功能时,第一步是创建仓库。仓库包含项目的所有文件,并为您提供与他人协作和管理工作的场所。有关详细信息,请参阅 创建新仓库

您可以根据需求为不同目的设置仓库。以下是一些常见用例

  • 产品仓库:较大的组织在特定产品上跟踪工作和目标时,可能会有一个或多个仓库来存放代码和其他文件。这些仓库也可用于文档、报告产品健康状况或产品的未来计划。
  • 项目仓库:您可以为自己正在进行的单个项目,或与他人协作的项目创建仓库。对于跟踪短期计划或项目的组织(例如咨询公司),需要报告项目健康状况,并根据技能和需求将人员在不同项目之间移动。项目的代码通常包含在单个仓库中。
  • 团队仓库:对于将人员分组为团队并向其分配项目的组织(例如开发工具团队),代码可能分散在多个仓库中,以跟踪他们需要的不同工作。在这种情况下,拥有一个团队专属仓库作为追踪团队所有工作的一站式位置会很有帮助。
  • 个人仓库:您可以创建个人仓库,以在一个地方跟踪所有工作、规划未来任务,或甚至添加想要保存的笔记或信息。如果想与他人共享这些信息,也可以添加协作者。

如果您希望对源代码和议题、讨论的访问权限进行不同的设置,可以创建多个独立的仓库。有关详细信息,请参阅 创建仅用于议题的仓库

在本指南的以下示例中,我们将使用一个名为 Project Octocat 的示例仓库。

传达仓库信息

您可以为仓库创建 README.md 文件,以介绍您的团队或项目并传达重要信息。README 通常是访问者看到的第一项内容,您还可以提供有关用户或贡献者如何开始使用项目以及如何联系团队的信息。有关详细信息,请参阅 关于仓库 README 文件

您还可以创建一个 CONTRIBUTING.md 文件,专门包含用户或贡献者如何对团队或项目做出贡献和互动的指南,例如如何打开 bug 修复议题或请求改进。有关详细信息,请参阅 为仓库贡献者设置指南

README 示例

我们可以创建一个 README.md 来介绍我们的新项目 Project Octocat。

Screenshot of the README.md file for the octo-org/project-octocat repository, with details about the project and how to contact the team.

创建议题模板

您可以使用议题来跟踪跨职能团队或项目涉及的不同类型工作,并收集项目外部的信息。以下是议题的一些常见用例。

  • 发布跟踪:您可以使用议题来跟踪发布进度或发布当天需要完成的步骤。
  • 大型计划:您可以使用议题来跟踪大型计划或项目的进展,并将其链接到较小的议题。
  • 功能请求:您的团队或用户可以创建议题来请求对产品或项目的改进。
  • 错误:您的团队或用户可以创建议题来报告错误。

根据您所使用的仓库和项目类型,您可能会优先处理某些类型的议题。确定团队最常见的议题类型后,您可以为仓库创建议题模板和表单。议题模板和表单使贡献者在打开议题时可以从一组标准模板中选择。有关详细信息,请参阅 为您的仓库配置议题模板

议题模板示例

下面我们在 Project Octocat 中创建一个用于报告错误的议题模板。

Screenshot of the form to create a new issue template. The fields are completed to create a template named "Bug report for Project Octocat."

现在我们已经创建了错误报告议题模板,您在 Project Octocat 中创建新议题时即可选择它。

Screenshot of the "New issue" page for octo-org/project-octocat, with the option to use the "Bug report for Project Octocat" template.

打开议题并拆分工作

您可以通过创建议题来组织和跟踪工作。有关详细信息,请参阅 创建议题

议题示例

以下是在 Project Octocat 中为大型计划(前端工作)创建的议题示例。

Screenshot of an issue called "Front-end work for Project Octocat." The issue body includes a list of tasks to complete.

子议题示例

您可以为议题添加子议题,以快速将较大的工作拆分为更小的议题。子议题通过在议题之间建立关系,为 GitHub 的层级结构提供支持。通过拆分任务,您可以创建多层级的子议题,精确呈现项目所需的细节层次。请参阅添加子议题浏览子议题

您可以使用议题类型在组织内对仓库中的工作进行分类,如任务、错误和功能。请参阅 在组织中管理议题类型

Screenshot of the sub-issues section below the issue description.

任务列表示例

您可以使用任务列表将较大的议题拆分为更小的任务,并将议题作为更大目标的一部分进行跟踪。任务列表在议题正文中具有额外功能。您可以在议题顶部看到已完成任务数与总任务数的比例,并且如果有人关闭了任务列表中链接的议题,复选框会自动标记为完成。有关详细信息,请参阅 关于任务列表

下面我们在 Project Octocat 的议题中添加了任务列表,将其拆分为更小的议题。

Screenshot of an issue called "Front-end work for Project Octocat." The issue body contains a task list, with a checkbox preceding each issue link.

标签示例

下面是我们创建并添加到议题的 front-end 标签示例。

Screenshot of an issue called "Front-end work for Project Octocat." In the right sidebar, in the "Labels" section, the "front-end" label is applied.

显示哪些议题受到阻塞或阻塞其他工作

通过创建议题依赖关系,您可以轻松查看并传达哪些议题被其他议题阻塞,或正在阻塞其他议题。这有助于简化协作,防止瓶颈,并提高团队透明度。请参阅 创建议题依赖关系

了解新议题

注意

你需要拥有 GitHub Copilot 的访问权限。有关详细信息,请参阅 GitHub Copilot 是什么?

在处理不熟悉或复杂的议题时,GitHub Copilot 能帮助您快速了解上下文、历史和关键信息,从而更快、更有信心地开始工作。

审阅议题

  1. 在 GitHub 上导航到议题。

  2. 在 GitHub 任意页面的右上角,点击搜索栏旁的 图标。

    GitHub Copilot Chat 面板已显示。要调整面板大小,请点击并拖动顶部或左侧边缘。

  3. 如果面板中包含您之前与 Copilot 的对话,请点击右上角的加号图标以开始新对话。

  4. 在 Copilot 聊天面板底部的 “Ask Copilot” 输入框中,输入问题并按 Enter。例如,您可以输入:

    • 概括此议题的要点
    • 此议题的目标是什么?

Copilot 的摘要将帮助您把握工作的目的和范围。

了解历史和评论

议题常包含讨论和决策的历史,这些信息可以提供重要上下文。您可以使用 Copilot 总结这些对话,以识别关键点,如提出的解决方案或未解答的问题。例如,您可以让 Copilot 总结最近的评论或突出已做出的决定。这有助于您聚焦最相关内容,并确保您的贡献与团队的优先级保持一致。

澄清技术术语

议题中常提及的技术术语、代码或文件可能并不立刻明晰。您可以使用 Copilot 获取这些引用的解释或上下文。例如,您可以询问某个文件或函数的用途,或议题中提到的特定术语含义。这有助于您在不必额外查阅文档或代码的情况下了解细节。

获取下一步建议

一旦了解了议题的上下文,Copilot 可以帮助您思考如何推进。您可以请求关于如何着手工作的建议,例如修复错误或实现新功能。例如,您可以询问:“解决此议题的最佳方法是什么?”或 “我该如何开始处理这个问题?” Copilot 的建议可以提供有用的起点,帮助您更有效地规划工作。

团队协作决策

您可以使用议题和讨论在团队内部就计划的改进或项目优先级进行沟通和决策。当您为特定细节(如错误或性能报告、下季度计划、新计划的设计)创建议题时,议题非常有用。讨论则适用于跨仓库的开放式头脑风暴或反馈。有关详细信息,请参阅 在 GitHub 上沟通

作为团队,您也可以在议题内沟通日常任务的更新,让所有人了解工作状态。例如,您可以为一个大型功能创建议题,多个成员在该议题中添加各自的进展或未解答的问题。

带有项目协作者的议题示例

以下是项目协作者在 Project Octocat 议题中提供工作状态更新的示例。

Screenshot of an issue called "Front-end work for Project Octocat." Comments from both @codercat and @octocat provide status updates on the work.

使用标签突出项目目标和状态

您可以为仓库创建标签,以对议题、拉取请求和讨论进行分类。GitHub 还为每个新仓库提供默认标签,您可以编辑或删除这些标签。标签有助于跟踪项目目标、错误、工作类型以及议题状态。

有关详细信息,请参阅 管理标签

在仓库中创建标签后,您可以在任何议题、拉取请求或讨论中应用它。随后,您可以通过标签过滤议题和拉取请求,以查找所有相关工作。例如,使用 front-endbug 标签过滤,即可找到项目中的所有前端错误。有关详细信息,请参阅 过滤和搜索议题与拉取请求

标签示例

下面是我们创建并添加到议题的 front-end 标签示例。

Screenshot of an issue called "Front-end work for Project Octocat." In the right sidebar, in the "Labels" section, the "front-end" label is applied.

将议题添加到项目

您可以使用 GitHub 上的项目来计划和跟踪团队的工作。项目是一个可自定义的电子表格,会与您的议题和拉取请求集成,自动保持与 GitHub 信息同步。您可以通过过滤、排序和分组议题和 PR 来自定义布局。要开始使用项目,请参阅 项目快速入门

项目示例

以下是示例项目的表格布局,已填入我们创建的 Project Octocat 议题。

Screenshot of the table view of a project, containing a list of issues, with columns for "Title," "Assignees," "Status," "Labels," and "Notes."

我们也可以将同一项目以看板形式查看。

Screenshot of the board view of a project, with issues organized into columns for "No Status," "Todo," "In Progress," and "Done."

后续步骤

您已经了解了 GitHub 为计划和跟踪工作提供的工具,并开始为您的跨职能团队或项目仓库进行设置!以下是一些有助于进一步自定义仓库和组织工作的资源。

© . This site is unofficial and not affiliated with GitHub, Inc.