Skip to content

mean-weasel/bugdrop

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

338 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

BugDrop 🐛

CI Version Security Policy Live Demo GitHub Marketplace Product Hunt

In-app feedback → GitHub Issues. Screenshots, annotations, the works.

Featured on Product Hunt and ranked #6 Product of the Day on May 9, 2026.

bugdrop-demo-small

Quick Start

Works with both public and private repositories!

1. Install the GitHub App on your repository:

https://github.com/marketplace/bugdrop-in-app-feedback-to-github-issues

2. Add the script to your website:

<script src="https://bugdrop.neonwatty.workers.dev/widget.js" data-repo="owner/repo"></script>

That's it! Users can now click the bug button to submit feedback as GitHub Issues.

Important: Do not add async or defer to the script tag — the widget needs synchronous loading to read its configuration.

CSP note: If your site uses a Content Security Policy, add https://bugdrop.neonwatty.workers.dev to your script-src directive to enable the widget.

Branch protection: BugDrop works with repos that have branch protection rules (required PRs, merge queues). Screenshots are stored on a dedicated bugdrop-screenshots branch that is auto-created on first use — no manual setup needed.

Security note: BugDrop is not a spam or malware filtering service. Treat feedback and screenshots as unauthenticated user-generated content. Exclude bugdrop-screenshots from CI/deploy workflows, and self-host behind your own WAF/CAPTCHA/content controls for stricter environments.

Features

  • 🔒 Privacy masking — tag sensitive elements with data-bugdrop-mask and BugDrop visually covers them in supported screenshot modes before submission. Passwords and credit-card inputs are masked automatically.

Widget Options

Attribute Values Default
data-repo owner/repo required
data-theme light, dark, auto auto
data-position bottom-right, bottom-left bottom-right
data-color Accent color for buttons/highlights (e.g. #FF6B35) #14b8a6 (teal)
data-label Any string Feedback
data-category-labels JSON mapping for self-hosted category labels built-in labels
data-button true, false true

See full documentation for all options including styling, submitter info, and dismissible button.

Documentation

How It Works

User clicks bug button → Widget captures screenshot → Worker authenticates via GitHub App → Issue created in your repo
  1. Widget loads in a Shadow DOM (isolated from your page styles)
  2. Screenshot captured client-side using html-to-image
  3. Worker (Cloudflare) exchanges GitHub App credentials for an installation token
  4. GitHub API creates the issue with the screenshot stored in .bugdrop/ on a dedicated bugdrop-screenshots branch (auto-created on first use)

Live Demo

Try it on WienerMatch — click the bug button in the bottom right corner.

License

MIT

About

In-app feedback → GitHub Issues. Screenshots, annotations, the works.

Topics

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages