DEV Community

Sameer Khan
Sameer Khan

Posted on

Never Miss a Bug Again: Enforce Screenshots in PRs with GitHub Actions

๐Ÿš€ Supercharge Your PRs with PR Quality Enforcer:

Frustrated with vague pull requests and missing screenshots? Meet **PR Quality Enforcer* โ€“ your GitHub Actions hero!*


๐ŸŽฏ The Pain of Shoddy PRs

Ever opened a pull request only to find:

  • โŒ No screenshots for UI changes โ€“ leaving reviewers guessing?
  • โŒ Cryptic descriptions like "Fixed stuff" โ€“ wasting everyone's time?
  • โŒ Endless back-and-forth โ€“ delaying merges?

Weโ€™ve all been there. Thatโ€™s why I built PR Quality Enforcer to transform chaos into clarity.


check is getting pass

check is getting failed without screenshot

โœจ How PR Quality Enforcer Works Its Magic

This open-source tool automates PR quality checks using GitHub Actions. Hereโ€™s how:

1. ๐Ÿง  Smart PR Templates

Every PR starts with a clear structure to guide contributors:


markdown
### Changes Made  
- [ ] Screenshot attached  
- [ ] Description of changes included  

**Screenshots**:  
<!-- Drag and drop images here -->  

**Related Issues**:  
<!-- Link to Jira/GitHub issues -->

---

## ๐Ÿ”ฅ Proof in Action

Hereโ€™s what it looks like in a real-world repo:

### โŒ Before: A Failing PR

No screenshots attached? Boom. The check fails with a red โŒ and a clear message.

> The checklist wasnโ€™t completed, and the `check_screenshots` job failed fast.

### โœ… After: A Passing PR

Screenshots added and template filled? Now you're talking. The check passes with a satisfying green โœ….

> All checks passed, including `check_screenshots`. Reviewers can merge with confidence.

---

## ๐Ÿš€ Why Youโ€™ll Love It

- โšก **30% Faster Reviews** โ€“ No more asking for basics
- ๐Ÿ‘จโ€๐Ÿ’ป **Better Contributions** โ€“ Newbies know what's expected
- ๐Ÿ› **Fewer Bugs** โ€“ Visual proof catches UI issues early

---

## ๐Ÿ’ป Get Started Now!

Add this to your repoโ€™s `.github/` folder:

- `.github/workflows/pr-screenshot-check.yml`
- `.github/PULL_REQUEST_TEMPLATE.md`

๐Ÿ”— GitHub Repo: [github.com/org-sameer/pr-quality-enforcer](https://github.com/org-sameer/pr-quality-enforcer)

---

## ๐Ÿ’ฌ Join the Revolution

- ๐Ÿ’ญ **Whatโ€™s your biggest PR pet peeve?**
- ๐Ÿค– **Tried automating PR quality checks yet?**

Drop a comment or open an issue.  
โญ Star the repo. Contribute. Make PRs better, together.


Enter fullscreen mode Exit fullscreen mode

Top comments (0)