参与 MRTK2 工作

  • 项目

欢迎社区参与混合现实工具包 (MRTK) 工作。 所有更改（无论大小）都需要遵守 MRTK 编码标准。 请确保你在开发过程中熟悉这些内容，以避免在审查更改时出现延迟。

如果你有任何疑问，请在 Slack 上的 mixed-reality-toolkit 频道中联系。 可通过自动邀请发送程序加入 Slack 社区。

提交过程

我们提供多种便于开发人员参与混合现实工具包工作的方式，所有方式都从创建新问题开始。

Select Issue Type

从这里，你可以提出：

  • Bug 报告 - 混合现实工具包某个组件的功能问题
  • 文档问题 - 混合现实工具包文档问题
  • 功能请求 - 混合现实工具包新功能提议

提出功能请求

请求混合现实工具包新功能时，请务必记录要解决的客户权益/问题。 功能请求提交后，我们会在 GitHub 上对其展开审核和讨论。 我们鼓励对每个功能提议展开公开且有建设性的讨论，确保这项工作对大部分客户有利。

为了避免需要重新修改功能，建议功能审核期间不要开始功能开发。 社区审核流程经常会发现一个或多个可能需要在提议的实现中进行重大更改的问题。

注意

如果我们的积压工作中包含你要提出的问题，可以使用该工作项作为提议。 另外，请确保对任务进行注释，以通知维护人员你正在完成该任务。

参与流程

要开始，请按照以下步骤操作：

  1. 创建存储库分支。 单击页面右上方的“分叉”按钮，然后按流程操作。
  2. 在分支中创建分支（非主分支），以便在准备好提交任何更改之前，更轻松地隔离更改。 对于发布版稳定期间的 bug 修复，请查找最新的 prerelease/* 分支。 新功能应始终进入 main。

如果你不熟悉 Git 工作流，请从 GitHub 查看此简介。

添加 bug 修复或功能时，请执行以下步骤：

  1. 实现 bug 修复或功能。 有关如何生成和部署 MRTK 的说明，请参阅部署到 HoloLens 和 WMR 设备。 请记住遵循编码准则。
  2. 如果添加功能，还应添加演示该功能的示例场景。
  3. 如果添加实验性功能，则无需编写测试和文档。 相反，请遵循实验性功能指南。
  4. 添加用于验证错误修复/功能的测试。 有关如何编写并运行测试的说明，请参阅 UnitTests。
  5. 请确保按照文档指南所述记录代码和功能。
  6. 确保代码在所有平台上按预期方式工作。 有关支持的平台列表，请参阅发行说明。 对于 Windows UWP 项目，代码必须符合 WACK 标准。 为此，请生成 Visual Studio 解决方案，并右键单击项目；“Microsoft Store”>“创建应用包”。 按照提示操作并运行 WACK 测试。 确保测试都成功。
  7. 发出拉取请求时，请按照拉取请求中的说明进行操作。