Docs header transparent bg

错误分类

分类是指处理用户提交的工单。常见任务包括验证错误、对工单进行分类,并确保有足够的信息来重现错误,以便任何想要尝试修复错误的人都能做到。

我们创建了一个 问题模板 来引导用户了解如何报告与 Bundler 项目相关的问题。我们还提供了一个 故障排除指南 来诊断常见问题。

并非每个工单都是 Bundler 代码中的错误,但打开的工单通常意味着我们可以做一些改进来帮助该用户。有时这意味着编写额外的文档或使错误消息更清晰。

对现有问题的分类

当你查看一个工单时,以下是一些需要问的主要问题

  • 我能否自己重现这个错误?
  • 工单中是否清楚地记录了重现错误的步骤?
  • 哪些版本的 Bundler(2.1.x、2.2.x、git 等)会出现此错误?
  • 哪些操作系统(macOS、Windows、Ubuntu、CentOS 等)会出现此错误?
  • 哪些 Ruby 版本(MRI、JRuby、Rubinius 等)以及哪些版本(3.0.1、3.1.2 等)存在此错误?

对工单进行分类的策略:* 务必要求用户输出其 bundle env 的全部内容。有时用户会忘记在问题中发布其 bundle env 输出的全部内容。* 在查看用户 bundle env 的输出后,尝试在当前环境中复制用户的问题。每次发布只会更改代码库的一部分,因此你的 Bundler 版本很可能存在相同的错误。* 如果你在当前环境中难以复制用户的问题,请尝试逐步合并用户的环境设置。也就是说,从这里开始匹配他们的环境。例如,尝试逐步切换到用户的 Ruby、RubyGems、RVM 等版本。* 用户是否运行的是最新版本的 Bundler?如果不是,请让他们通过运行 gem install bundler 来更新。最新版本的 Bundler 可能已经解决了他们的问题。

如果问题仍然需要用户提供信息,请应用标签“需要用户反馈”。这将有助于在将来识别陈旧的问题。

如果你无法重现问题,很可能该错误已经修复(太棒了!)。这时,你可以向工单发布帖子,说明你做了什么以及它是如何工作的。

如果你可以重现问题,那么你已经走上了修复问题的道路。:)

修复您已分类的错误

欢迎并鼓励每个人修复任何未解决的错误,改进错误消息或添加文档。如果您有修复或改进您想贡献的票证,我们有一个小指南来帮助您

  1. 在现有问题上讨论修复。与其他所有人协调可以避免重复工作,并且如果您需要任何建议和想法,这是一个很好的方法。
  2. 查看 拉取请求指南
  3. 将代码提交到您分支中的命名分支,至少包含一个测试来涵盖您的更改。
  4. 向我们发送一个来自您的错误修复分支的 拉取请求

您不必在您的 PR 中更新 CHANGELOG。我们的发布脚本将根据每个 PR 的标题自动准备它。

重复项!

最后,该票证可能是另一个较旧票证的重复项。如果您发现一个票证是重复的,只需在票证上评论,并注明原始票证的编号。例如,您可以说“这是问题 #42 的重复项,可以关闭”。

陈旧问题

任何等待更多信息的议题,我们都可以认为是“陈旧”的。流程如下

  1. 如果问题在一段时间内(2-4 周)没有更新,我们通常会留下评论说“嘿 :wave:,这对你来说还是个问题吗?”。
  2. 如果他们在 1-2 周内没有回复,我们将关闭该票证。
  3. 如果他们回复并说这仍然是一个问题,我们将提醒我们正在等待更多信息。
  4. 如果用户在被提醒后没有提供所需的信息,该票证将被关闭。
在 GitHub 上编辑此文档,如果您发现错误或遗漏。