Bug Reporting

English | 简体中文

Module Overview

The Bug Reporting module provides professional defect reporting guidance, helping testing teams write clear, complete, and actionable bug reports to improve defect resolution efficiency and team collaboration.

Core Features

🐛 Complete Bug Report Structure

• Clear Title: Concise and descriptive bug title
• Detailed Description: Complete bug reproduction steps
• Expected vs Actual: Clear expected and actual results
• Evidence: Screenshots, videos, and logs

🎯 Effective Communication

• Severity Classification: Critical, High, Medium, Low
• Priority Setting: P0, P1, P2, P3
• Environment Details: OS, browser, version information
• Reproducibility: Consistent, Intermittent, Random

🔍 Quality Standards

• Reproducible: Clear steps to reproduce
• Specific: Precise and unambiguous description
• Isolated: One issue per bug report
• Actionable: Provides enough information for developers

🌐 Tool Integration

• Jira: Popular bug tracking system
• Azure DevOps: Microsoft DevOps platform
• GitHub Issues: GitHub issue tracking
• Bugzilla: Open-source bug tracking

File Description

Chinese Prompts

• File: BugReportingPrompt.md
• Role: Senior QA Engineer (10+ years experience)
• Use Case: Chinese project teams, bug reporting standards

English Prompts

• File: BugReportingPrompt_EN.md
• Role: Senior QA Engineer
• Use Case: International teams, English project environments

Lite Version Prompts

• File: BugReportingPrompt_Lite.md / BugReportingPrompt_Lite_EN.md
• Features: Quick start, focused on core bug reporting elements
• Use Case: Quick bug reporting and basic documentation

Usage Guide

Quick Start

1. Select Prompt File

   • Full Version: Comprehensive bug reporting with all details
   • Lite Version: Quick bug reporting with essential information

2. Prepare Bug Information

   Bug Summary: [Brief description of the issue]
   Steps to Reproduce: [Detailed reproduction steps]
   Expected Result: [What should happen]
   Actual Result: [What actually happens]
   Environment: [OS, browser, version, etc.]

3. Get Professional Bug Report

   • Well-structured bug report
   • Appropriate severity and priority
   • Complete reproduction steps
   • Relevant attachments and evidence

Related Modules

• Functional Testing - Functional bug identification
• Test Reporting - Bug metrics and reporting
• Test Strategy - Defect management strategy

Learning Resources

Recommended Books

• "Software Testing"
• "Lessons Learned in Software Testing"
• "Perfect Software and Other Illusions"

Online Resources

• Bug Writing Guidelines
• How to Report Bugs Effectively
• Bug Reporting Best Practices

Contribution Guide

Welcome to contribute to the Bug Reporting module:

1. Share Examples: Share excellent bug report examples
2. Best Practices: Share bug reporting best practices
3. Templates: Provide bug report templates
4. Tool Tips: Share bug tracking tool tips

License

This module follows the MIT License. See the LICENSE file in the project root directory for details.

---

Write better bug reports, fix issues faster! 🐛✨