Get the App
SLTechnology News&Howtos  ›  Internet Technology  › 

How to write Bug report by Elika J. Etemad (fantasai)

Shulou Source: shulou.com Published: 2022-06-03 05:43:02 10月03日 Update

How to write Bug report

If the test fails, congratulations, you have found a bug, which may be the browser bug, may be a special case, or the problem may be the test case.

What kind of bug report is practical?

The practical bug report is...

Reproducible-if the developer cannot reproduce the bug, he is likely to mark it as "invalid" and skip it to continue other work.

Professional-the more timely the developer can understand and grasp the key points, the more likely the bug will be fixed.

So the goal of the bug report is.

Clearly point out bug

Like developer interpreting bug

General guidelines for the bug report.

Avoid repetition and search for relevant information

Always test on the latest version and communicate with the version manager all the time

Each report contains only one bug, while two bug distract the developer.

List useful facts and do not include personal opinions and complaints

Bug related to privacy and information security should be clearly marked

How to write it exactly.

A good bug report should contain the following information:

Summary-A good summary makes bug easy to find in this search engine, well-defined and concise

Bad example: Drag Crash

Good example: Drag-selecting any page crashes Mac builds in NSGetFactory

Description-the purpose of the description is to explain bug to developers, including:

Abstract summary of behavior

How to tell if it's a bug?

All relevant specification links

Interpretation of norms

Other ways of implementation

Reproduction method-the purpose of the reproduction method is to tell developers how to reproduce bug in their own environment. It can be a simple sentence or a detailed description of the steps:

Step 1: Load the attached testcase in Browser XYZ

Step 2: Scroll to the bottom of the page

Step 3: Click the link

Step 4: Press tab to navigate links

Test results-the test results include two parts: the expected results and the actual results, which are like the developer explaining what went wrong, and the expected results describe the behavior that should be.

Environment and configuration-the bug report must contain the environment and configuration parameters for the environment in which the bug appears

Additional information-any useful information, including URL, error message, error code, screenshot, screenshot video

Tags: Report development results information testing developer environment interpretation utility two examples practice method usefulness purpose behavior error search expectation configuration Apple Docker Huawei Linux macOS MariaDB Microsoft MySQL NVidia OPPO Reno macOS MySQL Shulou Information Shulou Technology OPPO Reno