简介
无论是在个人项目还是跨职能团队中工作,都可以使用 GitHub 代码库、问题、项目和其他工具来规划和跟踪工作。
在本指南中,您将学习如何创建一个存储库,并将其设置为与一群人协作,创建问题模板和表单,打开问题并使用任务列表来分解工作,并建立一个项目(经典)来组织和跟踪问题。
创建存储库
在启动一个新项目、计划或功能时,第一步是创建一个存储库。存储库包含您项目的所有文件,并为您提供一个与他人协作和管理您工作的地方。有关更多信息,请参阅“创建新存储库”。
您可以根据需要为不同的目的设置存储库。以下是一些常见的用例
- 产品存储库:跟踪围绕特定产品开展的工作和目标的大型组织可能有一个或多个包含代码和其他文件的存储库。这些存储库还可用于文档编制、报告产品运行状况或产品的未来计划。
- 项目存储库:您可以为正在进行的个人项目或与他人协作的项目创建一个存储库。对于跟踪短期计划或项目工作的组织(例如咨询公司),需要报告项目的运行状况,并根据技能和需求在不同项目之间调配人员。项目的代码通常包含在一个存储库中。
- 团队存储库:对于将人员分组为团队并向他们提供项目的组织(例如开发工具团队),代码可能分散在许多存储库中,以跟踪他们需要跟踪的不同工作。在这种情况下,拥有一个团队特定的存储库可能会有所帮助,作为跟踪团队参与的所有工作的单一位置。
- 个人存储库:您可以创建一个个人存储库,以在一个地方跟踪您的所有工作,规划未来的任务,甚至添加您想要保存的笔记或信息。如果您想与他人共享此信息,还可以添加合作者。
如果您希望为源代码和跟踪问题和讨论设置不同的访问权限,则可以创建多个独立的存储库。有关更多信息,请参阅“创建仅限问题存储库”。
对于本指南中的以下示例,我们将使用名为 Project Octocat 的示例存储库。
传达存储库信息
您可以为您的代码库创建一个 README.md 文件,以介绍您的团队或项目,并传达有关它的重要信息。README 通常是访问者看到您的代码库时的第一项内容,因此您还可以提供有关用户或贡献者如何开始使用该项目以及如何联系团队的信息。有关更多信息,请参阅“关于 README”。
您还可以专门创建一个 CONTRIBUTING.md 文件,其中包含有关用户或贡献者如何参与和与团队或项目互动(例如如何打开错误修复问题或提出改进请求)的指南。有关更多信息,请参阅“为代码库贡献者设定指南”。
README 示例
我们可以创建一个 README.md 来介绍我们的新项目 Project Octocat。
创建问题模板
您可以使用问题来跟踪您的跨职能团队或项目涵盖的不同类型的工作,以及收集项目外部人员的信息。以下是问题的一些常见用例。
- 版本跟踪:您可以使用问题来跟踪版本进度或完成发布当天的步骤。
- 大型举措:您可以使用问题来跟踪大型举措或项目的进度,然后将其链接到较小的任务。
- 功能请求:您的团队或用户可以创建问题来要求改进您的产品或项目。
- 错误:您的团队或用户可以创建问题来报告错误。
根据您正在处理的代码库和项目类型,您可能会优先考虑某些类型的任务。一旦您确定了团队中最常见的问题类型,您就可以为您的代码库创建问题模板和表单。问题模板和表单允许您创建标准化模板列表,贡献者可以在您的代码库中打开问题时从中进行选择。有关更多信息,请参阅“为您的代码库配置问题模板”。
问题模板示例
下面我们正在为 Project Octocat 中的错误报告创建一个问题模板。
现在我们创建了错误报告问题模板,您可以在 Project Octocat 中创建新问题时选择它。
打开问题并使用任务列表来跟踪工作
你可以通过创建问题来组织和跟踪你的工作。有关更多信息,请参阅“创建问题”。
问题示例
以下是为 Project Octocat 中的大型计划(前端工作)创建的问题示例。
任务列表示例
你可以使用任务列表将较大的问题分解为较小的任务,并将问题作为较大目标的一部分进行跟踪。将任务列表添加到问题正文时,它们具有附加功能。你可以在问题的顶部看到已完成的任务总数,如果有人关闭了任务列表中链接的问题,则复选框将自动标记为已完成。有关更多信息,请参阅“关于任务列表”。
下面我们向 Project Octocat 问题添加了一个任务列表,将其分解为较小的任务。
作为团队做出决策
你可以使用问题和讨论与团队沟通并就计划中的改进或项目的优先级做出决策。当你创建问题来讨论具体细节时,问题很有用,例如错误或性能报告、下一季度的规划或新计划的设计。讨论对于开放式头脑风暴或反馈很有用,它不限于代码库和跨存储库。有关更多信息,请参阅“在 GitHub 上进行沟通”。
作为团队,你还可以就日常任务在问题中沟通更新,以便每个人都知道工作的状态。例如,你可以为多人正在处理的大型功能创建一个问题,每个团队成员都可以添加其状态或在该问题中打开问题。
带有项目合作者的问题示例
以下是项目合作者在 Project Octocat 问题上提供工作状态更新的示例。
使用标签来突出显示项目目标和状态
你可以为存储库创建标签,以对问题、请求和讨论进行分类。GitHub 还为每个新存储库提供默认标签,你可以对其进行编辑或删除。标签对于跟踪项目目标、错误、工作类型和问题状态很有用。
有关更多信息,请参阅“管理标签”。
在存储库中创建标签后,可以将其应用于存储库中的任何问题、请求或讨论。然后,您可以按标签筛选问题和请求,以查找所有关联的工作。例如,通过筛选带有front-end
和bug
标签的问题,找到项目中的所有前端错误。有关更多信息,请参阅“筛选和搜索问题和请求”。
标签示例
下面是front-end
标签的示例,我们创建了该标签并将其添加到问题中。
将问题添加到项目(经典版)
可以在 GitHub 上使用项目来规划和跟踪团队的工作。项目是一个可自定义的电子表格,它与 GitHub 上的问题和请求集成,并自动更新 GitHub 上的信息。您可以通过筛选、排序和分组问题和请求来自定义布局。要开始使用项目,请参阅“项目快速入门”。
项目示例
下面是示例项目的表格布局,其中填充了我们创建的 Project Octocat 问题。
我们还可以将同一项目视为看板。
您还可以使用 GitHub 上现有的项目(经典版)来规划和跟踪您或您团队的工作。项目(经典版)由问题、请求和注释组成,这些内容按您选择的列分类为卡片。您可以创建用于功能工作、高级路线图甚至发布清单的项目(经典版)。有关更多信息,请参阅“关于项目(经典版)”。
项目(经典版)示例
下面是 Project Octocat 示例的项目(经典版),其中添加了我们创建的问题以及我们将其分解为更小问题。
后续步骤
您现在已经了解了 GitHub 提供的用于规划和跟踪工作的工具,并开始设置您的跨职能团队或项目存储库!以下是一些有用的资源,可用于进一步自定义存储库和组织工作。
- "关于存储库",了解有关创建存储库的更多信息
- "使用问题跟踪你的工作",了解有关创建和管理问题的不同方法的更多信息
- "关于问题和 Pull Request 模板",了解有关问题模板的更多信息
- "管理标签",了解如何创建、编辑和删除标签
- "关于任务列表",了解有关任务列表的更多信息
- "关于项目",了解有关项目的更多信息
- "更改视图的布局",了解如何自定义项目的视图
- "关于项目(经典)",了解如何管理项目(经典)