问题分类
本指南适用于维护人员。这些特殊人员对一个或多个 Jekyll 存储库拥有写入权限,并帮助合并他人的贡献。你可能会觉得这里写的内容很有趣,但它绝对不是针对每个人的。
在评估问题之前,重要的是确定它是一个功能请求还是一个错误。对于 Jekyll 项目,使用以下定义来识别功能或错误
功能 - 功能被定义为在 Jekyll 当前功能之外向 Jekyll 添加功能的请求。错误 - 错误被定义为用户(或用户)在使用当前 Jekyll 功能时遇到的错误识别问题。
功能?
如果问题描述了一个功能请求,请询问
- 这是一个设置吗?设置是一种“做正确的事情”的权宜之计。设置通常指向一个错误的默认值或一个可以通过插件轻松解决的边缘情况。保持设置
尽可能小,以免降低产品的可用性。我们喜欢“决策而非选项”的理念。
- 至少 80% 的用户会觉得它有用吗?如果我们四分之一的用户都不会使用它,那么该请求很可能不符合我们产品的核心目标。
- 有没有其他方法可以实现该请求的最终目标?大多数功能请求都是由于对现有功能的文档或理解不佳造成的。看看你是否可以明确请求的最终目标。用户想做什么?他们可以通过我们已经支持的另一项功能来实现该目标吗?
- 即使 80% 的用户会使用它,它是否符合我们项目的核心目标?我们正在编写一个用于制作静态网站的工具,而不是一个更通用的瑞士军刀,用于更广泛的发布。
随时获取他人的意见并向问题作者提问,但根据上述问题的答案,它可能超出我们项目的范围。
如果请求在范围内,请与其他维护者一起在产品路线图中对其进行优先级排序。应用适当的标签并确保适当的人员参与定义功能的范围和实现。如果您想成为有史以来最好的,请自行提交一个添加该功能的 PR。
错误?
可重复性
如果错误有明确的可重复步骤,请花一分钟时间尝试一下。如果有帮助,请在我们的测试套件中编写一个测试,用于复制问题的场景。您能可靠地复制该问题吗?
如果您无法复制该问题,请发布您未执行的复制步骤,并向问题作者寻求澄清。
支持的平台
作者是否使用受支持的平台?我们支持 macOS、Ubuntu、Debian、CentOS、Fedora 和 Arch Linux 的最新版本。
如果作者无法在受支持的平台上复制该问题,您可以立即关闭该问题。对于与 Windows 相关的问题,请发表评论,让用户知道 Windows 未得到官方支持,但他们绝对可以继续使用该问题与 @jekyll/windows
中的人员进行交流以进一步调查。此外,您可以将他们指向 Jekyll Talk (https://talk.jekyllrb.com) 作为从社区获取支持的一种方式。
如果用户在 GitHub Pages 或我们无法复制的另一个托管平台上遇到问题,请将他们引导至该平台的支持渠道并关闭该问题。
他们想要什么与他们得到什么
一个没有明确解释用户得到什么以及他们期望得到什么的问题是我们无法准确回答的问题。如果用户未提供此信息,请寻求澄清并应用 pending-feedback
标签。此信息有助于我们构建测试用例,以便我们将来不会再次破坏行为。一旦问题作者发布回复,pending-feedback
标签将自动删除。
他们想要的东西是我们想要发生的事件吗?有时,错误报告实际上伪装成功能请求。请参阅上述指南以处理功能请求。
陈旧和自动关闭
@jekyllbot 如果至少一个月没有活动,将自动将问题标记为 陈旧
。 @jekyllbot 会留下评论,询问有关当前版本中可复制性的信息。如果在另一个月后没有人回复,则该问题将自动关闭。可以通过设置 固定
标签 来禁止此行为。