Software & DevOpsDeveloper Workflow

High-Signal GitHub & GitLab Bug Report Issue Template

Designed to eliminate vague developer bug tickets. Enforces clear reproduction steps, environment telemetry, and log trace blocks.

software-bug-report-github.md•57 lines•269 words
---
name: "Bug Report"
about: "Create a detailed report to help engineering reproduce and fix a bug"
title: "[BUG]: "
labels: ["bug", "triage-needed"]
assignees: ""
---

## 🐛 Bug Description
A clear and concise description of what the bug is.

---

## 🔁 Steps to Reproduce
Steps to reproduce the behavior:
1. Navigate to `/tools/compress-pdf`
2. Select and upload a 15MB PDF containing scanned images
3. Adjust compression slider to `Medium Quality (75%)`
4. Click `Compress Document`
5. Observe that the progress indicator freezes at 84% without throwing an alert

---

## 🎯 Expected Behavior
The compression process should finish, calculate the saved byte ratio, and trigger the browser download prompt with the output PDF.

---

## 💥 Actual Behavior & Error Output
The UI becomes unresponsive for 12 seconds, the progress bar halts, and the console records an unhandled memory exception.

```bash
# Browser Console Stack Trace
Uncaught RangeError: Array buffer allocation failed at PDFWriter.build (pdf-lib.esm.js:1420)
  at async handleCompress (CompressorWorker.ts:88)
  at async HTMLButtonElement.dispatch (bundle.js:412)
```

---

## 🖥️ Environment & System Information
- **DocSwift Version / Commit Hash:** `v2.4.1` (`a8c1f9b`)
- **Operating System:** macOS Sonoma 14.5 (Apple Silicon M2)
- **Browser:** Google Chrome Version 128.0.6613.120 (Official Build) (arm64)
- **Device:** Desktop (Retina 4K Display)
- **File Type / Size Tested:** Scanned Contract PDF (14.8 MB, 32 pages)

---

## 📸 Screenshots or Video Captures
<!-- If applicable, paste a link or drag-and-drop screenshots here -->

---

## 🔍 Additional Context
- Issue does not reproduce on Safari 17.4 or Firefox 129.
- Memory snapshot shows JS heap usage spiking from 45MB to 820MB during the canvas rasterization step.
💡 Ready to customize? Copy and paste directly into your preferred text editor or IDE.Open in DocSwift Tool

How to Use & Customize This Template

1

Add to Repository

Save this file as `.github/ISSUE_TEMPLATE/bug_report.md` in your Git repository root.

2

Fill Out Minimum Reproducible Example

Provide exact numbered steps that allow any developer to recreate the defect within 60 seconds.

3

Format Console Traces

Wrap error outputs and API responses inside code blocks to preserve line breaks and call stacks.

Pro Formatting & Best Practice Tips

  • Include exact browser version numbers and OS platforms; browser-engine bugs often only trigger on specific versions.
  • Always paste the complete unminified console error stack trace rather than just a screenshot.
  • Mention if the bug reproduces in Incognito mode to rule out interference from browser extensions.

Recommended DocSwift Tools for This Workflow

Frequently Asked Questions

Where should this template be placed in a GitHub repo?

Place the template file in `.github/ISSUE_TEMPLATE/bug_report.md`. GitHub automatically detects it when contributors click "New Issue".

Can this template be used with GitLab or Jira?

Yes! The markdown body is fully compatible with GitLab issue templates (`.gitlab/issue_templates/Bug.md`) and can be pasted directly into Jira markdown tickets.