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

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

简介

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

在本指南中,您将学习如何创建和设置一个与一群人合作的仓库,创建议题模板,打开议题并使用任务列表来分解工作,并建立项目委员会来组织和跟踪议题。

创建仓库

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

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

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

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

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

沟通仓库信息

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

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

README 示例

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

创建 README 示例

创建议题模板

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

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

根据您处理的仓库和项目类型,您可以将某些类型的议题置于其他议题之上。 在为团队确定最常见的议题类型后,您可以为仓库创建议题模板。 议题模板允许您创建标准化的模板列表,供贡献者在您的仓库中打开议题时选择。 更多信息请参阅“为仓库配置议题模板”。

议题模板示例

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

创建议题模板示例

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

选择议题模板示例

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

您可以通过创建议题来组织和跟踪您的工作。 更多信息请参阅“创建议题”。

议题示例

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

创建一个大型计划议题示例

任务列表示例

您可以使用任务列表将较大的议题分解成较小的任务,并将追踪议题作为更大目标的一部分。 更多信息请参阅“关于任务列表”。

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

向议题添加任务示例

以团队身份作出决定

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

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

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

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

协作处理议题示例

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

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

更多信息请参阅“创建标签”。

在仓库中创建标签后,您可以将其应用于仓库中的任何议题、拉取请求或讨论。 然后您可以通过标签过滤问题和拉取请求来查找所有相关的工作。 例如,过滤具有 front-endbug 标签的议题,在项目中找到所有前端错误。 For more information, see "Filtering and searching issues and pull requests."

标签示例

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

向议题添加标签的示例

添加议题到项目板

您还可以 使用 GitHub 上的项目板来规划和跟踪您或您团队的工作。 项目板包括议题、拉取请求和注释,在选择的列中分类为卡片。 您可以为功能工作、高级路线图甚至发布检查表创建项目板。 更多信息请参阅“关于项目板”。

项目板示例

下面是我们的示例项目 Octocat 的项目板, 其中我们创建了议题,并且分解成较小议题 添加到项目板。

项目板示例

后续步骤

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

此文档对您有帮助吗?

隐私政策

帮助我们创建出色的文档!

所有 GitHub 文档都是开源的。看到错误或不清楚的内容了吗?提交拉取请求。

做出贡献

或者, 了解如何参与。