A clear bug report gives someone else enough information to understand the failure, reproduce it, and compare what happened with what should have happened. Describe one issue at a time, write precise steps and inputs, separate expected from actual results, and include only the environment details and evidence that could help explain it.
What to include in a bug report
Use the project’s issue form if it provides one; its fields take priority over a generic template. Mozilla recommends one report per issue, a distinct summary, and precise reproduction steps. Atlassian’s Jira template also calls out severity and environment, while MDN’s browser guidance emphasizes isolating the behavior with a minimal test case. These are useful approaches, not a universal mandatory form: Mozilla Bug Writing Guidelines, Atlassian’s Free Bug Report Template, and MDN’s browser bug-report guidance.
- Summary: Identify the affected feature, observable failure, and important condition.
- Environment: Give relevant app or software version, operating system, device, and browser version where applicable.
- Frequency: Say whether it happens every time, intermittently, or only happened once so far.
- Steps to reproduce: Number the actions, including setup and exact inputs that matter.
- Expected result: State what you thought would happen.
- Actual result: State what happened instead; copy exact error text if available.
- Evidence: Attach a minimal test case, screenshot, or log only when it makes the problem easier to understand.
- Notes: Mention potentially relevant conditions or recent changes, clearly marking anything you suspect but have not confirmed.
Write a specific, searchable summary
A title such as “It’s broken” gives maintainers almost nothing to search or triage. Name the affected feature and the visible failure, then add the condition that distinguishes it when useful. For example: “Checkout shows a blank page after applying a discount code.” This reports an observation without assuming its cause.
Keep each report focused on one issue. If two failures can be reproduced independently, file separate reports rather than combining them under one vague title. Mozilla’s guidance stresses that clear summaries help others identify and search for reports.
Quick wins for a faster PC:
Clear out junk files and repair common Windows errorsFree Scan →Scan for outdated or missing drivers - takes under a minuteDriver Scan →Repair Windows errors before they cause bigger problemsFix Now →#1 Best Overall
- PERFECT GIFTS: A hardcover notebook is a thoughtful gift to impress your friends, coworkers, or loved ones, a writing journal for women's work journal is both practical and stylish, and a must-have for stationery lovers.
- VERSATILE USE: Spiral notebooks are perfect for school, office, classroom, home, business, and travel. You can use college ruled notebook for note-taking, journaling, drawing, sketching, composing, and meeting notebooks.
- EASY TO CARRY: Perfectly sized to fit in your bag, backpack, or briefcase, ensuring you can take a spiral notebook college ruled and be inspired anytime, anywhere.
- SIZE: Our journaling notebooks measure approximately 5.5X8.3 inches with 164 lined pages, journals for writing perfect for whatever you're writing.
- QUALITY PAPER: The college notebook paper is smooth and acid-free, which prevents ink from bleeding and ensures that your writing is clear and crisp on every page.
Make the reproduction steps repeatable
Write the steps as a recipe someone unfamiliar with your session can follow. Start from the necessary initial state, include actual inputs, and do not assume the reader knows which account, page, setting, or sequence you used.
- Start from the relevant setup, such as a specific page, account state, or enabled setting.
- Perform one action per step, using the same labels and controls visible in the software.
- Include any input that affects the outcome, such as the text entered, file type, or selected option.
- End at the point where the failure becomes visible and describe what to look for.
If the steps do not reproduce the issue reliably, say so. Report how often it occurs and under what conditions you noticed it; do not present a one-time observation as a guaranteed reproduction. Mozilla identifies reproduction steps as central to a bug report.
Separate expected behavior from actual behavior
State the two sides of the discrepancy independently. “Expected: the page displays the order confirmation. Actual: the page remains blank after submitting the order” is clearer than a blended sentence such as “the order confirmation is broken.” Keep this section factual: describe what you observed, not a diagnosis you have not verified.
Add relevant environment details
Software failures can depend on versions or platform differences. Include details that could change the result, for example:
Rank #3
- Sturdy Construction: Our Lined Spiral Journal Notebook is built to last with a sturdy metal twin-wire binding and a tough hardcover. The water-resistant cover shields your notes from damage, while the double-wire design allows for easy folding and flat laying.
- High-Quality Paper: Crafted from 100 GSM thick, ink-friendly paper, our notebook prevents ink bleed-through and ghosting. It accommodates various pens, including ballpoint, gel, and fountain pens. Each page features a day header for effortless date tracking.
- Organized and Functional Design: With 140 lined pages and a 6-page blank table of contents, our notebook offers ample space for note-taking and easy referencing. An inner pocket keeps miscellaneous items secure, and an elastic closure band ensures the notebook stays closed when not in use.
- Versatile Usage: Suitable for office, school, and home environments, our notebook is perfect for journaling, note-taking, drawing, goal setting, Bible, and planning. It's a thoughtful present for friends, family, classmates, and colleagues.
- Medium-Sized Portability: Measuring 6 inches x 8 inches, our medium notebook strikes the perfect balance between portability and functionality. Its sturdy construction and aesthetic design make it an ideal companion for all your writing endeavors.
- Application or software version
- Operating system and device
- Browser and browser version for a browser-related issue
- Connection type, if it appears relevant
- Frequency and reproducibility conditions
Do not fill the report with every detail you can find. Include context that helps someone reproduce or narrow the problem, and follow the project’s form if it asks for specific fields.
Attach evidence that helps, not noise
A minimal test case is often more useful than a long description of a complex setup. For browser issues, MDN recommends reducing the case to the smallest example that still shows the behavior and checking other browsers when that comparison could clarify the issue. Include browser version, expected and actual behavior, and a relevant screenshot or other requested report-form details.
Rank #4
- ✅ Elevate Your Workspace Aesthetic: Featuring a charming Cute Ladybug A5 Spiral Notebook design, this journal is an instant desk statement. The vibrant, spring-inspired cover sparks daily inspiration and workplace smiles, making it the perfect whimsical garden themed notebook for professionals who want to express their personality.
- ✅ Premium Ink-Proof Writing Experience: Tired of ghosting? Our funny work journaling notebooks feature 80g thick, cream-toned paper that handles gel pens and markers like a pro. The eye-friendly hue reduces strain during long grinds, ensuring your work from home planner stays neat, organized, and legible on both sides.
- ✅ 360° Lay-Flat Flexibility for Commuters: Designed with a sturdy metal twin-wire binding, this ladybug doodle Heavyweight Hardcover notebook flips 360° for easy handheld notes or lies 180° flat for a seamless writing surface. Ideal for cramped coffee shop tables or quick corporate meeting minutes without the annoying spine bulge.
- ✅ Durable Good Luck Vibes Hardcover for Life on the Go: Say goodbye to bent corners! This funny daily work planner is protected by a heavy-duty, water-resistant hardcover. Whether it’s tossed into a crowded backpack or a daily commute tote, it shields your notes from damage, keeping your desk aesthetics notepad looking brand new.
- ✅ Thoughtful Hilarious Gifts for Any Occasion: Looking for funny gifts for friends? With 160 pages of ruled clarity, this Ladybug daily work planner is a versatile companion for task tracking, manifesting good luck, or venting. It serves as a perfect white elephant gifts for Women Men office, ideal for birthdays or promotions.
A screenshot can show a visual state or error message, but it may not explain the steps that led there. Pair it with the reproduction recipe when needed. Before attaching screenshots, logs, or test data, remove credentials, personal information, private customer data, and other material the project should not receive.
Independent reader supportYour contribution helps us test, update, and keep practical guides available for everyone.Bug report template
Copy this template and omit fields that do not apply, unless the project’s issue form requires them:
Summary: [Product or feature] [observable failure] when [important condition]Environment: [app and version], [operating system/device], [browser and version if relevant]Frequency: [every time / sometimes / once so far; conditions if known]Steps to reproduce:
1. [Starting state or setup]
2. [Action and input]
3. [Next action]Expected result: [What you thought should happen]Actual result: [What happened instead; exact error text if available]Evidence: [Minimal test case, screenshot, log, or attachment if useful and safe to share]Notes: [Relevant condition or recent change; label unconfirmed explanations as uncertain]Capture a browser failure with a clean screenshot
For a browser bug, a screenshot can document the page state at the point of failure. You can capture one yourself in a browser, or use ScreenshotNeo, a website screenshot API and MCP server for developers. If you capture evidence, include it only when it clarifies the failure and is safe to share.
Or skip the browser setup:
ScreenshotNeo can return a screenshot from one GET request. Create an API key, then replace YOUR_API_KEY and the example URL with your values:
Quick Recap
curl -G "https://api.screenshotneo.com/v1/shot" -d access_key=YOUR_API_KEY --data-urlencode url=https://stripe.com -o shot.webpSee the ScreenshotNeo API documentation for request options. It accepts cookie or consent banners and removes more than 60 known consent platforms, newsletter popups, and chat widgets before capture; each of those steps can be turned off. Bot checks or CAPTCHAs, blank pages, timeouts, failed loads, and cache hits are not billed, and response headers indicate the page verdict and billing status. Its MCP server provides take_screenshot, get_page_info, and capture_pdf for AI agents and MCP clients. The free plan includes 1,000 screenshots a month with no card; paid plans start at $5 for 3,000 screenshots.
Sign up for ScreenshotNeo’s free plan.
Check the report before submitting
- Does the summary say what failed and when?
- Can another person follow the steps without guessing at setup or inputs?
- Are expected and actual behavior stated separately?
- Have you included relevant versions and the honest frequency?
- Does the attachment clarify the failure, and is it safe to share?
- Have you kept unverified explanations separate from observed facts?
Product prices and availability are accurate as of the date/time indicated and are subject to change. Any price and availability information displayed on Amazon at the time of purchase will apply.
Recommended Free Tools
