Skip to main content
Screendesk
Free tool

Bug Report Template

Fill in a structured bug report with steps to reproduce and auto-detected environment details, then copy it as Markdown, Jira, GitHub, or plain text.

Open source on GitHub

Bug details

Be specific: the page or feature, what goes wrong, and the trigger.

Environment

Detected from this browser; edit if you reproduced the bug somewhere else. Nothing leaves your device.

Steps to reproduce
1.
2.
3.
4.
Attachments
# Checkout “Pay now” button does nothing after applying a discount code

**Severity:** Critical  
**Frequency:** Every time

## Environment
- **URL:** https://example.com/checkout
- **Browser:** Chrome 130
- **OS:** macOS 15
- **Viewport:** 1440 × 900
- **App version:** v2.4.0 (staging)

## Steps to reproduce
1. Add any product to the cart
2. Go to checkout and apply discount code SAVE10
3. Enter test card 4242 4242 4242 4242 with any future date and CVC
4. Click “Pay now”

## Expected result
The payment is processed and the order confirmation page loads.

## Actual result
Nothing happens. The button stays enabled and no request is sent.

## Console errors
```text
Uncaught TypeError: Cannot read properties of undefined (reading 'total')
    at applyDiscount (checkout.js:214:31)
```

## Attachments
- [x] Screen recording
- [ ] Screenshot
- [x] Console logs
- [ ] Network requests (HAR)
- [ ] Test account or data used
- [ ] Link to failing test case

## Notes
Works without a discount code.
Best practice

What makes a bug report reproducible. Three things developers ask for first.

  • Steps anyone can follow

    Start from a known state, number each action, and include the test data used. If a developer can’t reproduce it, they can’t fix it.

  • The exact environment

    Browser, version, operating system, viewport, and app build. Many bugs only appear in one browser or at one screen size.

  • Evidence, not just words

    A screen recording, console errors, and failed network requests show what happened faster than a paragraph describing it.

Template fields

Bug report template fields. What to write in each section.

Bug report template sections with examples
SectionWhat to includeExample
TitleWhere it happens, what goes wrong, and the trigger“Pay now” does nothing after applying a discount code
EnvironmentURL, browser and version, OS, viewport, app buildChrome 130, macOS 15, 1440 × 900, v2.4.0
Steps to reproduceNumbered actions from a known starting point1. Add a product 2. Apply SAVE10 3. Click “Pay now”
Expected resultWhat should happenThe order confirmation page loads
Actual resultWhat happens insteadNothing happens; no request is sent
Severity and frequencyHow bad it is and how often it happensCritical, every time
Console errorsErrors from the browser console, pasted as textTypeError at checkout.js:214
AttachmentsRecording, screenshot, logs, HAR fileScreen recording, console logs

More examples on the blog: bug report templates for different teams and tools, and a bug report example walked through field by field.

FAQ

Frequently asked questions

What should a bug report include?

A specific title, the environment (browser, OS, viewport, app version), numbered steps to reproduce, the expected result, the actual result, severity, how often it happens, and evidence such as a screen recording, console errors, and network requests.

How do I paste a bug report into Jira?

Choose the Jira format to get wiki markup with headings, a numbered step list, an environment table, and a noformat block for console errors. Wiki markup renders in Jira Data Center and in wiki-rendered fields; in the Jira Cloud editor, try pasting the Markdown version instead.

How is the browser and OS detected?

The tool reads your browser’s user agent and window size when the page loads, entirely in your browser. Nothing is sent to Screendesk. Edit the fields if you reproduced the bug on a different device.

Can I use this as a GitHub issue template?

Yes. The GitHub format uses Markdown headings, an environment table, a fenced code block for console errors, and task-list checkboxes for attachments. Paste it into a new issue, or save the blank version as an issue template in your repository.

How do I capture console logs and network requests for a bug report?

Open your browser’s developer tools, reproduce the bug, then copy errors from the Console tab and export a HAR file from the Network tab. Screendesk captures both automatically alongside a screen recording, so you don’t need to do it by hand.

Customer support runs on Screendesk.

Start for free