Bug Report and Issue Tracking Template
A useful bug report tells a developer exactly what broke, how to trigger it, and what evidence proves it. Pair that report with a tracker organized by status, and a team can move each issue from discovery to a verified fix without losing context.
What is a bug report?
A bug report is a handoff document: it gives developers enough context to reproduce a defect, understand its impact, and verify a fix. It can live in a ticketing system, a project management tool, or a simple spreadsheet, as long as the report stays attached to the tracked issue until closure.
Organize by status, then by feature
Sort issues by status first. Open covers newly submitted or unaddressed bugs. In progress means someone is actively working on the issue. On hold means investigation has started but progress is blocked, for example by missing information or higher-priority work. Closed means the issue is fully resolved. When one feature needs repeated fixes, add a feature subgroup inside each status so related defects can be handled together.
Write a report developers can act on
Start with a concise title naming the affected feature or behavior. Then document reproduction: say whether the defect is intermittent or repeatable, and if repeatable, list each step in order. State the expected result separately from the actual result, and attach a screenshot or screen capture showing the failure. A worked example: Title — Export button downloads an empty file. Steps — open the report, choose Export, download. Expected — a populated file downloads. Actual — the download is empty, shown in the capture. Environment — browser, device, and operating system. Scope — how many customers are affected. Console — any logged errors, captured as a screenshot.
Pre-submission checklist
Use this checklist before submitting: Is the title specific? Can another person reproduce it from the steps? Are expected and actual results separated? Is visual evidence attached? Are browser, device, and operating system noted? Is the number of affected customers stated? Are console errors included when present? If any answer is no, add that detail first — it usually saves a round of questions.
Choose a view that matches the work
Gantt view adds dates and dependencies, so fixes can be sequenced across sprints and moved by drag and drop. Notes hold the detailed report, while comments hold screenshots and discussion. Color-coding can signal priority, status, or owner at a glance. List view keeps the same drag-and-drop behavior in a simpler layout. Board view places statuses in columns; tasks can be moved manually or advanced automatically at a completion threshold, such as moving to Closed at 100% complete.
| Status | Meaning | Team action |
|---|---|---|
| Open | Newly submitted or not yet addressed | Triage and assign |
| In progress | Actively being worked on | Investigate and fix |
| On hold | Started but blocked or awaiting information | Record the blocker |
| Closed | Fully resolved | Verify and close |
Status definitions as described for organizing bug reports.
| View | Best for | Key capability |
|---|---|---|
| Gantt view | Planning fix timing | Scheduling, dependencies, drag and drop |
| List view | Simple shared logging | Simplified drag-and-drop organization |
| Board view | Visual status movement | Columns by status, manual or threshold-based moves |
View descriptions based on template examples; capabilities depend on the chosen tool.
Frequently asked questions
What should a bug report include?
Give the defect a short name, list repeatable steps to trigger it, state what should happen, show what actually happens with a screenshot or capture, and add environment, scope, and console errors when available.
How should a bug tracker be organized?
Group reports by status — Open, In progress, On hold, and Closed — then optionally by feature, so the team can see where each issue stands and what to tackle next.
Which tracker view fits which workflow?
Gantt view suits scheduling and dependencies, List view suits a simple shared log, and Board view suits moving cards across status columns as fixes progress.