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

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

本文内容

介绍

可使用 GitHub 存储库、议题、项目及其他工具来规划和跟踪你的工作，无论是单个项目或跨职能团队。

本指南将介绍如何创建和设置一个与一群人合作的存储库、创建问题模板和表单、创建问题并使用任务列表细分工作，以及建立 项目（经典） 来组织和跟踪问题。

创建仓库

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

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

  • 产品存储库：围绕特定产品跟踪自身工作和目标的大型组织可能有一个或多个包含代码和其他文件的存储库。 这些仓库也可用于文档、产品健康报告或产品未来计划。
  • 项目存储库：可为正在处理的单个项目创建存储库，也可为正在与他人协作的项目创建存储库。 对于跟踪为短期计划或项目工作的组织，如咨询公司，需要报告项目的健康情况，并根据技能和需求在不同项目之间移动人员。 项目代码通常包含在单个仓库中。
  • 团队存储库：对于将人员分组到团队并将项目引入到团队（如开发工具团队）中的组织，代码可能会分散在多个存储库中，以便跟踪所需的不同工作。在这种情况下，使用特定于团队的存储库可能会有所帮助，可在其中跟踪团队参与的所有工作。
  • 个人存储库：可创建个人存储库，以便在一个位置跟踪你的所有工作、规划未来的任务，甚至添加想要保存的笔记或信息。 如果您想与他人共享此信息，您还可以添加协作者。

如果您想要源代码以及跟踪问题和讨论的不同访问权限，则可以创建多个单独的仓库。 有关详细信息，请参阅“创建仅含议题的仓库”。

对于本指南中的以下示例，我们将使用称为 Octocat 项目的示例仓库。

沟通仓库信息

您可以为您的仓库创建 README.md 文件来介绍您的团队或项目并传递有关它的重要信息。 README 通常是访问仓库的访客看到的第一项，因此您还可以提供有关用户或贡献者如何开始项目以及如何联系团队的信息。 有关详细信息，请参阅“关于自述文件”。

您还可以创建一个 CONTRIBUTING.md 文件，专门包含有关用户或贡献者如何参与及与团队或项目互动的准则，例如如何打开错误修复问题或请求改进。 有关详细信息，请参阅“设置仓库参与者指南”。

README 示例

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

octo-org/project-octocat 存储库 README.md 文件的屏幕截图，其中包含有关项目以及团队联系方式的详细信息。

创建议题模板

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

  • 发布跟踪：您可以使用议题来跟踪发布进度或发布当天完成的步骤。
  • 大型倡议：您可以使用议题来跟踪大型计划或项目的进度，然后这些计划或项目将链接到较小的议题。
  • 功能请求：您的团队或用户可以创建议题，要求改进您的产品或项目。
  • 错误：您的团队或用户可以创建议题来报告错误。

根据您处理的仓库和项目类型，您可以将某些类型的议题置于其他议题之上。 在为团队确定最常见的问题类型后，可为存储库创建问题模板和表单。 使用问题模板和表单可创建标准化的模板列表，供参与者在存储库中创建问题时选择。 有关详细信息，请参阅“为仓库配置议题模板”。

议题模板示例

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

用于创建新议题模板的窗体的屏幕截图。 完成这些字段以创建名为“Octocat 项目的 Bug 报告”的模板。

现在我们已经创建了错误报告模板，您在项目 Octocat 中创建新议题时可以选择它。

octo-org/project-octocat 的“新建议题”页的屏幕截图，其中包含使用“Octocat 项目的 Bug 报告”模板的选项。

打开议题并使用任务列表来跟踪工作

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

问题示例

下面是 Octocat 项目中为大型计划（前端工作）创建的议题示例。

名为“Octocat 项目前端工作”的议题的屏幕截图。 议题正文包含要完成的任务列表。

任务列表示例

您可以使用任务列表将较大的议题分解成较小的任务，并将追踪议题作为更大目标的一部分。 任务列表添加到问题正文时具有额外的功能。 在问题顶部可看到总任务数中已完成的任务数。如果有人关闭任务列表中链接的问题，其对应的复选框将自动标记为完成。有关详细信息，请参阅“关于任务列表”。

下面，我们在 Octocat 项目议题中添加了任务列表，将其分解为较小的议题。

名为“Octocat 项目前端工作”的议题的屏幕截图。 议题正文包含一个任务列表，每个议题链接前面都有一个复选框。

使用子问题分解工作

Note

对于组织，问题类型、子问题和高级问题搜索目前处于可选择加入的 公共预览版 中。 若要了解详细信息并将组织添加到等待列表，请参阅“GitHub 博客”。

可以向问题添加子问题，快速将较大的工作分解为任务。 子问题通过创建问题之间的关系，增加了对 GitHub 上的问题层次结构的支持。 可以创建多个层次结构级别，通过将任务精确地分解为你和你的团队所需的细节量来准确表示项目。请参阅“添加子问题”和“浏览子问题”。

以团队身份作出决定

您可以利用议题和讨论作为团队来沟通和决定计划的项目改进或优先级。 当您创建议题以讨论特定详细信息（如错误或绩效报告、下个季度的规划或新计划的设计）时，议题很有用。 讨论有助于在代码库之外和跨仓库进行开放式的集思广益或反馈。 有关详细信息，请参阅“在 GitHub 上通信”。

作为一个团队，您还可以在议题中传达日常任务的最新信息，以便每个人都知道工作状态。 例如，您可以为多人正在处理的大功能创建议题，每个团队成员都可以在该议题中添加其状态更新或未决问题。

与项目协作者合作的议题示例

下面是项目协作者就 Octocat 项目问题的工作提供状态更新的示例。

名为“Octocat 项目前端工作”的议题的屏幕截图。 来自 @codercat 和 @octocat 的注释提供关于工作的状态更新。

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

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

有关详细信息，请参阅“管理标签”。

在仓库中创建标签后，您可以将其应用于仓库中的任何议题、拉取请求或讨论。 然后您可以通过标签过滤问题和拉取请求来查找所有相关的工作。 例如，筛选具有 front-end 和 bug 标签的问题，在项目中查找所有前端 bug。 有关详细信息，请参阅“筛选和搜索议题以及拉取请求”。

标签示例

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

名为“Octocat 项目前端工作”的议题的屏幕截图。 在右侧边栏中的“标签”部分中，应用了“前端”标签。

向 项目（经典） 添加议题

可以使用 GitHub 上的 projects 来计划和跟踪团队的工作。 项目是一个可自定义的电子表格，集成您在 GitHub 上的议题和拉取请求，自动保持最新的 GitHub 信息。 您可以通过筛选、排序及分组议题和 PR 来自定义布局。 若要开始使用项目，请参阅“Projects 快速入门”。

项目示例

以下是一个示例项目的表布局，其中填充了我们创建的 Octocat 项目议题。

“Octocat 项目”项目的表视图的屏幕截图，其中包含议题列表，并包含“标题”、“被分派人”、“状态”、“标签”和“备注”列。

我们也可以将同一个项目视为一个板。

“Octocat 项目”项目的板视图的屏幕截图，该视图将各项议题分入“无状态”、“待办”、“正在进行”和“已完成”列。

后续步骤

您现在已经了解了 GitHub 提供的用于规划和跟踪您工作的工具，并且已经开始设置您的跨功能团队或项目仓库！ 以下是一些有用的资源，可进一步定制您的仓库和组织您的工作。