为 World Locking Tools for Unity 项目做出贡献

目前,要为 World Locking Tools 项目做出贡献,最有价值的方法就是提交问题。 关于要更好地将 World Locking Tools for Unity 项目与项目需求保持一致的任何反馈都非常有价值。

你发布的任何反馈都是有价值的,不过这里有一些建议可以让你的反馈更具操作性。

适当地使用标签

在最初提交问题时,以及作为参与者跟踪问题时,适当使用标签对于与其他参与者配合都非常有帮助。

请尝试准确区分 bug、功能请求以及更广泛的建议。 这些都是有价值的,不过在经过准确识别之后,它们能产生更高的价值。

同样,如果某个问题以其当前形式是不具可操作性的,那么应用适当的标签(例如“不明确”)有助于将该问题改进为具有可操作性的形式。 当然,问题本身中的特定说明非常有用。 但是适当的标签也许能引导其他人注意到可能被忽视的说明。

报告 Bug

可以从 GitHub 上的问题门户提交问题。 请花些时间上报问题或提交能让其他人从中受益且心怀感激的建议。

每个 bug 报告都有自己的上下文,但一般情况下,以下内容包含得越多,问题解决得越快。

来自设备的日志文件

设备中的日志文件对于调查问题非常有用,尤其是在与下面建议的屏幕捕获结合使用时。 连接到设备时,可使用 Windows 设备门户在 System > File explorer > User Folders \ LocalAppData \ WorldLockingTools 下获取它们

Unity 应用日志文件

UnityPlayer.log 位于 TempState 子文件夹中。 这是一个纯文本文件。

World Locking Tools 诊断记录

诊断文件位于 LocalState 子文件夹中。 文件的名称是根据以下模式自动生成的:

FrozenWorld-<device name>-<capture date and time>.hkfw

它是一个二进制文件,需要使用专门的软件来检查。

请注意,若要捕获诊断记录,需要在场景中的 World Locking Tools Manager 组件上启用诊断记录。 有关详细信息,请参阅诊断文档。

重现步骤

指定该问题是否会轻易发生。 理想的情况是,在某一组步骤之后,必然会出现某个 bug。 不过即使某个 bug 只出现了一次,也应尽可能详细地描述导致该问题的步骤。

应遵循以下常规形式重现步骤:

  1. 一开始正常且稳定的状态为...
  2. 然后我执行的操作(或者发现的异常情况)是...
  3. 然后系统就开始显示此错误行为...

屏幕截图

屏幕捕获有助于识别问题发生的完整上下文。 具体而言,在屏幕上显示 World Locking Tools 诊断有助于将体验与日志中的信息相关联。 屏幕捕获可以是快照图像,也可以是视频捕获。

设备信息

  • 什么类型的设备?
  • 运行的 OS 是什么版本?

生成环境

  • Unity 版本
  • Visual Studio 版本

对某项功能提出建议

如果你感觉 World Locking Tools 差一点就能实现你的需求,那么可能其他人也正面临同样的局限。 与提供新功能一样,我们对修复文档和示例中的空白也感兴趣。

在对某项新功能提出建议时,最重要的是要清晰地表达你希望实现的需求。 虽然关于如何实现它的想法也很有帮助,但能明确说明附加价值的建议更有可能获得支持。 明确阐述该功能可以解决的问题,最好是在真实场景中使用该功能可以完成的任务。

请确保将“增强”标签附加到提交的建议问题。

发布代码

这是一个开源项目,所以自然任何人都能随时开发一个分支。 如果有人能慷慨地将自己的成果共享回来,那么无论此内容是否会被合并进主存储库,我们都会非常感激。

在最初的推出阶段,我们将使用有限的资源来审查和接受对主存储库的拉取请求。 如果假定分支将被合并回主存储库,最好避免在该分支上投入太多时间。

减轻风险的一种方法是:在对某项实现投入大量时间之前,提交一个问题,说明意图(标记为“增强”)。 这样也有利于其他可能研究同一问题领域的参与者。

另请参阅

编码约定发布过程