OurBMC社区贡献指南之Issue使用指南

Issue 的定义

Issue 是指一项待完成的工作，这个工作可以是 “问题”、“事务”、“需求 “和” 建议 “等。每个 Issue 应该包含该问题的所有信息和历史，使得后来的人只看这个 Issue，就能了解问题的所有方面和过程。

OurBMC 社区直接使用 Gitee 提供的 Issue 跟踪和管理系统。

Issue 的功能

Issue 起源于客服部门。用户打电话反映问题，客服就创建一个工单（ticket），后续的每一个处理步骤、每一次与用户的交流，都要更新工单，记录全部信息。这就是 Issue 的前身。因此，Issue 的原始功能是问题追踪和工单管理，后来不断扩展，逐渐演变成全功能的项目管理工具，还可以用于制定和实施软件的开发计划。

Issue 作为团队协作中一种可以为我们大大提高效率的方式，可以使我们更方便的对整个仓库进行跟踪、增强和排错。在一个公开的仓库来说，任何人都可以使用 Issue，仓库的所有者和其他任何人都可以向该仓库提 Issue。

Gitee 官方的建议中，项目相关的技术问题、缺陷报告、建议等信息都可以通过 Issue 进行发布。

创建 Issue

（1）Gitee 中每一个 Repository 内都有一个 Issue 面板。

（2）进入该面板，点击 “+ 新建 Issue”，就可以新建一个 Issue，如下图所示。

（3）左侧填入 Issue 的标题和内容，右侧是几个配置项。下面简单介绍这些配置项的用法。

• 负责人：用于从当前 repository 的所有成员内指派对该 Issue 的处理人员，包括负责人和协作者。
• 标签：可以给该 Issue 贴上标签，便于对 Issue 进行分类管理和过滤筛选。
• 项目：可以给该 Issue 关联项目。只有 SIG 成员才有新增项目权限
• 里程碑：相关的 Issue 可以放到一个里程碑里。里程碑通常可以理解为不同的版本或不同的迭代。
• 关联分支：可以指明 Issue 针对的是哪个分支
• 计划开始 / 截止日期：可以给该 Issue 指明期望的计划开始和截止日期，便于领取任务的人参考。
• 置顶选项：可以选择是否让该 Issue 放置到 Issue 列表的顶部，以便于吸引大家的关注。
• 优先级：可以给 Issue 置顶优先级。

Issue 的评论

在仓库的 Issue 面板选择您感兴趣的 Issue，可查看该 Issue 的详情，并可对该 Issue 进行评论。

Issue 的全局视图

Issue 面板只能查看和操作当前的 repository，Gitee 还提供了 Issue 的全局视图。

组织的全局视图 ：您可以在 OurBMC 组织下直接点击 Issue 面板看到该组织下的所有 Issue。

个人的全局视图：点击组织的全局视图内的任何一个 Issue，您就进入了 “XX 个人工作台” 界面。点击左侧的 “任务”，您就可以查看和操作所有和您相关的 Issue。您可以选择两种显示模式，也可以在工具栏按不同的条件进行筛选、过滤和排序。

Issue 关联 Pull Request

Issue 关联 Pull Request，用户可以在关闭 Pull Request 的时候同时关闭 issue。关联功能具有以下特点：

• 一个 PR 可以关联多个 issue，例如同时关联 issue1，issue2 格式为：\#issue1ident, \#issue2dent
• PR 关联 issue 后，issue 的状态会自动更改为进行中，当 PR 被合并后，issue 会更改为关闭状态。

个人版和企业版的区别：

• 个人版，PR 只能关联当前仓库的任务
• 企业版，PP 可以关联所有企业的任务

具体 Issue 关联 Pull Request 操作如下

（1）在 Issue 详情页中指定需要关联的 PR

（2）当 PR 合并之后其关联的 Issue 被关闭