模板:BugReport/doc

{{BugReport}}模板用来为提报 Bug 提供一个初始模板。在公共讨论页面提问时，请使用 subst 替换引用。

撰写Bug报告

一份良好的缺陷报告应该有以下几个元素：

• 有一个简短清晰的标题，不冗长却明确。
  • 正面例子：“XXX模板定位错误”、“XXX页面出现显示问题”、“无法访问XXX页面”
  • 反面例子：“有BUG”（废话）、“我在访问XXX页面时发现了一个十分有趣的问题，不知道是不是有意为之，所以来这里问一下相关的技术人员”（标题别搁这儿凑字数）
• 视情况在问题描述中提到平台、浏览器等。
  • 正面例子：“使用移动版”、“使用Chrome 86访问”、“使用Kindle自带的浏览器”
• 在问题描述中提到复现频率。
  • 正面例子：“每次都能复现”、“经常复现”、“偶尔会出现问题”
• 在问题描述中总结出现的情况。
  • 正面例子：“编辑按钮无反应”、“编辑保存失败”、“在移动版无法显示”
  • 反面例子：“坏了”（说了跟没说一样）、“不能用”（我也知道不能用）
• 视情况提供系统给出的错误代码或错误信息。
  • 正面例子：“访问页面时显示403”、“页面显示‘您被限制在短时间段内执行太多次该操作’”、“多次出现编冲提示”
  • 反面例子：“弹出错误提示”（没写错误信息）、“访问不了”（没写错误代码）
• 在复现步骤中详细解释每一步。
  • 正面例子：“点击右上角的编辑按钮”、“打开侧边栏上的‘链入页面’”、“鼠标在文本上悬停”
  • 反面例子：“点一下上面那个按钮”（哪个按钮？）、“没法编辑”（怎么就没法编辑了？）
• 在期望行为中详细解释想要看到的结果。
  • 正面例子：“点击按钮后跳转至编辑界面”、“编辑能够正常保存”、“只显示雪碧图的一部分而不是全部”
  • 反面例子：“正常工作”（怎么样算正常工作？）、“能用”（太笼统了）
• 如果可能，提供用外部图床上传的截图。

参数

{{subst:BugReport|标题|问题描述|复现步骤|期望行为|影响范围|状态}}

前五个参数由于使用了{{trim}}，将会移除所有前导、后置的空格与换行。

状态参见#状态。

状态

内置状态

该模板内置了一些状态，可以直接作为匿名参数6使用。大小写不敏感。

默认值为pending，建议不要修改。

参数值	效果
Pending	状态：   待处理
Confirmed	状态：   已确认
Fixed	状态：   已修复
Unconfirmed	状态：   无法复现
NotABug	状态：   非Bug提报
Duplicate	状态：   重复提报
CantFix	状态：   无法修复

自定义状态

一般情况下内置状态足矣，但是如果有自定义状态的需求的话，该模板的匿名参数6和7分别与{{状态}}的匿名参数1和2对应，亦支持color与prefix参数。具体用法请参见{{状态/doc}}。

代码	效果
{{BugReport/status|自定义文本}}	状态：   自定义文本
{{BugReport/status|拒绝|啥破问题，不想回答}}	状态：   啥破问题，不想回答
{{BugReport/status|在修了，在修了|color=#1976d2|prefix=问题进度：}}	问题进度：   在修了，在修了

示例

{{subst:BugReport
|萌百娘太平了
|萌百娘过于[[贫乳]]，以致于被其他人调戏
|# 抓一只萌百娘
# 摸一摸她
|胸围增大50cm
|全站}}

效果
[BUG] 萌百娘太平了 状态：   待处理 问题 萌百娘过于贫乳，以致于被其他人调戏 复现步骤 抓一只萌百娘 摸一摸她 期望行为 胸围增大50cm 影响范围 全站 --示例用户（讨论） 2021年1月1日 (五) 00:00 (CST)