Bug report writing in Testing Fundamentals - Framework Patterns

Framework Mode - Bug report writing

Folder Structure for Bug Report Management

bug-reports/
├── open/
│   ├── BR-001-login-error.md
│   ├── BR-002-page-crash.md
├── in-progress/
│   ├── BR-003-ui-overlap.md
├── resolved/
│   ├── BR-000-login-button-fix.md
templates/
├── bug_report_template.md
README.md

This structure helps organize bug reports by status for easy tracking.

Bug Report Writing Layers

• Bug Identification: Tester finds and documents the bug with clear steps.
• Bug Description: Detailed explanation including expected vs actual results.
• Bug Classification: Severity, priority, and type of bug.
• Bug Tracking: Status updates as bug moves through fixing stages.
• Communication: Sharing bug reports with developers and stakeholders.

Configuration Patterns for Bug Reporting

• Templates: Use a standard bug report template to keep reports consistent.
• Environment Details: Include OS, browser, app version to reproduce bugs reliably.
• Severity and Priority: Define clear criteria for severity (impact) and priority (fix order).
• Access Control: Manage who can create, edit, or close bug reports.
• Integration: Connect bug reports with test cases and version control for traceability.

Bug Reporting and Integration

• Bug Tracking Tools: Use tools like Jira, Bugzilla, or GitHub Issues for managing bugs.
• Automated Notifications: Notify developers and testers when bugs are reported or updated.
• Reports and Dashboards: Generate summary reports showing open, fixed, and critical bugs.
• CI/CD Integration: Link bug status with build pipelines to block releases if critical bugs exist.
• Audit Trail: Keep history of changes to bug reports for accountability.

Best Practices for Bug Report Writing

1. Be Clear and Concise: Write simple steps to reproduce the bug so anyone can follow.
2. Include Screenshots or Videos: Visual evidence helps developers understand the issue faster.
3. Use Consistent Terminology: Avoid confusion by using agreed terms for features and errors.
4. Prioritize Bugs Properly: Focus on bugs that impact users most critically first.
5. Verify Before Reporting: Confirm the bug is reproducible and not a user error.

Self Check Question

Where in the folder structure would you add a new bug report for a UI alignment issue you just found?

Key Result

Organize bug reports clearly with templates, status folders, and integrate with tracking tools for effective communication.

Practice

1. What is the main purpose of writing a bug report in software testing?

easy

A. To clearly explain the problem and how to reproduce it

B. To praise the software for its features

C. To describe the software's design

D. To list all the software's functions

Solution

1. Step 1: Understand the role of a bug report

   A bug report is meant to communicate a problem clearly so developers can fix it.

2. Step 2: Identify the correct purpose

   Among the options, only explaining the problem and how to reproduce it matches the bug report's goal.

3. Final Answer:

   To clearly explain the problem and how to reproduce it -> Option A

4. Quick Check:

   Bug report purpose = clear problem explanation [OK]

Hint: Focus on clear problem explanation and reproduction steps [OK]

Common Mistakes:

• Confusing bug report with feature description
• Writing vague problem statements
• Ignoring reproduction steps

2. Which of the following is the correct way to write the 'Expected Result' in a bug report?

easy

A. The software crashes sometimes.

B. The software is slow.

C. I don't like how the software looks.

D. The software should save the file without errors.

Solution

1. Step 1: Understand what 'Expected Result' means

   It describes what should happen when the software works correctly.

2. Step 2: Choose the option that clearly states the correct expected behavior

   The software should save the file without errors. clearly states the expected behavior: saving the file without errors.

3. Final Answer:

   The software should save the file without errors. -> Option D

4. Quick Check:

   Expected result = correct software behavior [OK]

Hint: Expected result shows correct behavior, not opinions [OK]

Common Mistakes:

• Writing vague or subjective expected results
• Confusing actual and expected results
• Skipping expected result section

3. Consider this bug report snippet:

Steps to reproduce:
1. Open the app
2. Click 'Save'
3. Observe error message

Expected result:
File saves successfully

Actual result:
Error message 'Save failed'

What is the main problem this bug report helps identify?

medium

A. The save function shows an error instead of saving

B. The app crashes on startup

C. The error message text is correct

D. The app saves files too quickly

Solution

1. Step 1: Analyze the steps and results

   The steps show clicking 'Save' leads to an error message instead of saving.

2. Step 2: Match the problem with options

   The save function shows an error instead of saving correctly describes the issue: save function shows error instead of saving.

3. Final Answer:

   The save function shows an error instead of saving -> Option A

4. Quick Check:

   Bug report identifies save error issue [OK]

Hint: Match steps and results to find the problem [OK]

Common Mistakes:

• Ignoring actual vs expected results
• Misreading the steps
• Choosing unrelated options

4. A tester writes this bug report:

Steps:
1. Login
2. Click 'Profile'
3. See blank page

Expected: Profile page loads
Actual: Blank page

What is missing that would improve this bug report?

medium

A. The tester should add unrelated screenshots

B. The tester should remove the expected result

C. The tester should add environment details like browser and OS

D. The tester should write a longer story

Solution

1. Step 1: Review the bug report content

   The report has steps, expected and actual results but lacks environment details.

2. Step 2: Identify what improves bug reports

   Adding environment details helps developers reproduce and fix bugs accurately.

3. Final Answer:

   The tester should add environment details like browser and OS -> Option C

4. Quick Check:

   Environment details improve bug reports [OK]

Hint: Always include environment info for better bug reports [OK]

Common Mistakes:

• Skipping environment details
• Adding irrelevant information
• Ignoring clear reproduction steps

5. You find a bug that only happens when the user uploads a file larger than 5MB on a slow internet connection. What is the best way to write this bug report?

hard

A. Report the bug without any reproduction steps.

B. Report the bug with steps, expected vs actual results, and mention file size and network speed.

C. Report the bug but say it happens on all file sizes.

D. Report only that the upload fails without details.

Solution

1. Step 1: Identify key details for reproduction

   File size and network speed are important to reproduce this bug.

2. Step 2: Choose the option that includes clear steps and environment details

   Report the bug with steps, expected vs actual results, and mention file size and network speed. includes steps, expected vs actual results, and important conditions.

3. Final Answer:

   Report the bug with steps, expected vs actual results, and mention file size and network speed. -> Option B

4. Quick Check:

   Include all relevant details for complex bugs [OK]

Hint: Include all conditions that trigger the bug [OK]

Common Mistakes:

• Omitting important reproduction conditions
• Giving vague or incomplete steps
• Ignoring environment factors