Bug Report template thumbnail

SOFTWARE ENGINEERING TEMPLATE

Bug Report Template

Report a bug with reproduction steps, expected vs. actual behavior, and environment details.

Use this template

What's inside

Field

Value

Severity

Major

Priority

P2

Reporter

[Your name]

Date Reported

Assignee

[Name or "Unassigned"]

Status

Open

Component

[Affected component or service]

Version

[App version where the bug was found]

Summary

Write a 1-2 sentence description of the bug. Be specific about what is broken and when it occurs.

Steps to Reproduce

  1. Navigate to [specific page or screen]

  2. Perform [specific action, e.g., "Click the 'Save' button"]

  3. Observe [what happens, e.g., "The page displays a 500 error"]

Reproduction rate: [Always / Intermittent (~X% of attempts) / Once]

Expected Behavior

Describe what should happen when following the steps above. Reference documentation or specifications if applicable.

Actual Behavior

Describe what actually happens. Include exact error messages, incorrect values, or unexpected behavior. Be precise.

Environment

Field

Value

Operating System

[e.g., macOS 14.2, Windows 11, Ubuntu 22.04]

Browser

[e.g., Chrome 120, Firefox 121, Safari 17]

App Version

[e.g., v2.3.1 or commit hash]

Device

[e.g., Desktop, iPhone 15, Pixel 8]

Screen Resolution

[e.g., 1920x1080]

Network

[e.g., WiFi, LTE, Corporate VPN]

User Role

[e.g., Admin, Member, Guest]

Error Logs / Stack Trace

Include relevant error output from the browser console, server logs, or crash reports.

Paste error logs, stack traces, or console output here.
Include timestamps and log levels if available.

Workaround

Describe any known workaround that allows users to complete the task despite the bug. If no workaround exists, state "No known workaround."

Related Issues

Additional Context

Add any other context about the bug: when it started occurring, whether it was working before a specific release, relevant configuration settings, or feature flags.

Other Engineering templates