Lesson 13 of 17 · 15 min read

Writing a Great Bug Report & Jira Workflow

Write clear, reproducible bug reports with strong titles and evidence, and learn Jira issue types, boards, workflows and basic JQL.

Learning objectives

  • List the essential fields of a professional bug report
  • Write specific bug titles and reproducible steps with supporting evidence
  • Explain Jira issue types, Scrum and Kanban boards and a typical bug workflow
  • Write basic JQL queries to find and filter defects

A developer who receives your bug report has never seen what you saw. If the report is unclear, the bug gets rejected as "Cannot Reproduce", bounces back and forth, or is fixed incorrectly. A great bug report lets anyone reproduce the problem in under five minutes. In this lesson you will learn what to include, how to write titles that get attention, and how to work inside Jira, the most widely used defect tracking tool in Indian IT companies.

Fields of a Bug Report

FieldWhat to write
Bug IDGenerated automatically by the tool, e.g. SHOP-2187
Title / SummaryWhere + what + condition, in one line
EnvironmentBuild number, environment (QA/Staging), OS, device, browser and version
PreconditionsAccount type, data or settings needed before the steps
Steps to ReproduceNumbered, minimal, exact steps with test data
Expected ResultWhat should happen, ideally quoting the requirement
Actual ResultWhat actually happened, including exact error text
Severity and PriorityImpact and suggested urgency
ReproducibilityAlways, Intermittent (e.g. 3 out of 5 attempts), Once
AttachmentsScreenshots, screen recording, logs, API response
Linked itemsUser story, test case ID, related bugs

A Sample Bug Report

FieldValue
TitleCheckout: order total ignores coupon discount when payment method is changed from card to UPI
EnvironmentQA env, build 3.8.2, Android 14, mid-range test device
PreconditionsLogged-in user with one item of Rs 1,000 in cart; coupon SAVE100 is active
Steps1) Open Cart and apply coupon SAVE100. 2) Tap Proceed to Pay. 3) Select Credit Card; note total Rs 900. 4) Switch payment method to UPI.
ExpectedTotal remains Rs 900 with coupon applied (REQ-CHK-14)
ActualTotal changes to Rs 1,000; coupon line disappears; UPI request is raised for Rs 1,000
Severity / PriorityMajor / P1 (customers overcharged)
ReproducibilityAlways (5/5)
AttachmentsScreen recording, screenshot of both totals, network log of the price API response

Good vs Bad Bug Titles

The title is often the only thing a lead reads during triage. A good title answers where, what and under which condition.

Bad titleGood title
Login not workingLogin: "Invalid OTP" shown for correct OTP when entered after 50 seconds
App crashProfile: app crashes when uploading a JPG photo larger than 5 MB
Wrong amountCart: GST calculated on MRP instead of discounted price
Search issue!!!Train search: no results for valid station codes typed in lowercase

Evidence That Speeds Up Fixes

  • Screenshots with the problem area highlighted.
  • Screen recordings for multi-step or intermittent issues; keep them short.
  • Browser console and network logs from developer tools, including the failing API request and response.
  • Device logs for mobile crashes (for example, adb logcat output on Android).
  • Test data used: user ID, order ID or transaction reference so developers can trace it in logs and the database.
Protect sensitive data

Never paste real customer passwords, full card numbers, Aadhaar or PAN details into a bug report. Mask them, or use test accounts only.

Jira Essentials

Issue Types

  • Epic: a large body of work, e.g. "UPI AutoPay".
  • Story: a user-facing requirement within an epic.
  • Task: technical or non-user work, e.g. "Set up test environment".
  • Bug: a defect in the product.
  • Sub-task: a smaller piece of a story or task, e.g. "Write test cases for story SHOP-310".

Boards and Workflow

A Scrum board shows the work committed for the current sprint. A Kanban board shows a continuous flow of work with limits on work in progress. Both display columns that represent workflow states. A typical bug workflow is: To Do, In Progress, In Review, Ready for QA, QA In Progress, Done, with a path back to Reopened. Your company may name these differently, so learn your project's workflow in your first week.

JQL Basics

JQL (Jira Query Language) lets you search issues with SQL-like conditions. Save useful queries as filters and add them to your dashboard.

project = SHOP AND issuetype = Bug AND status = Open
project = SHOP AND issuetype = Bug AND status = "Ready for QA" AND reporter = currentUser()
project = SHOP AND issuetype = Bug AND priority in (Highest, High) AND created >= -7d
fixVersion = "3.8.2" AND resolution = Unresolved ORDER BY created DESC
project = SHOP AND issuetype = Bug AND text ~ "coupon"

Line by line, these queries return:

  1. All open bugs in the SHOP project.
  2. Bugs you reported that are now waiting for you to retest.
  3. High-priority bugs created in the last 7 days.
  4. Unresolved issues planned for release 3.8.2, newest first.
  5. Bugs mentioning "coupon" in their text, useful for finding duplicates.
Search before you log

Running a quick text search like the last query above before creating a bug prevents duplicates and shows reviewers that you are thorough.

Key takeaways

  • A great bug report can be reproduced by anyone in a few minutes
  • Titles should state where, what and under which condition
  • Always include environment, build number, exact steps, data and evidence
  • Jira issue types: Epic, Story, Task, Bug, Sub-task
  • Use JQL filters to track your bugs and search before logging new ones
✓ You're subscribed! Job alerts arrive daily at 9 AM.
Scroll to Top