模板:BugReport

模板文檔  

這個文檔嵌入自Template: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)