Software & DevOpsCode Review Workflow

High-Signal GitHub & GitLab Pull Request Review Template

Speed up engineering code reviews with clear changelog summaries, before/after visual demos, testing steps, and rollback flags.

github-pull-request-template.md•36 lines•206 words

## 📌 Summary of Changes
- Migrated PDF compression engine to 100% client-side WebAssembly (WASM).
- Reduced memory footprint on mobile devices by 38% via canvas chunk recycling.
- Resolves issue #428.

---

## 🔍 Type of Change
- [ ] 🐛 Bug fix (non-breaking change which fixes an issue)
- [x] ✨ New feature (non-breaking change which adds functionality)
- [ ] 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] 📝 Documentation update only
- [ ] ⚡ Performance improvement / refactoring

---

## 📸 Before & After Visual Demos

| Before (v2.4) | After (v2.5) |
| :---: | :---: |
| ![Before](https://via.placeholder.com/350x200?text=Previous+UI) | ![After](https://via.placeholder.com/350x200?text=Optimized+WASM+UI) |

---

## 🧪 Testing Verification Checklist
- [x] Unit test suite passes locally (`npm run test`) with 88% coverage.
- [x] Tested in Google Chrome 128 (Desktop & Android emulation).
- [x] Tested in Apple Safari 17.5 (macOS & iOS 17.4 device).
- [x] Verified zero outbound network requests in DevTools Network tab during document processing.

---

## 🚀 Deployment & Rollback Considerations
- **Database Migrations:** None required.
- **Environment Variables:** None required.
- **Rollback Procedure:** Safe to execute standard Vercel/Cloudflare one-click deployment rollback without side effects.

💡 Ready to customize? Copy and paste directly into your preferred text editor or IDE.Open in DocSwift Tool

How to Use & Customize This Template

Add to Repository

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

Enforce Testing Verification

Require PR authors to check off testing items before team code review begins.

Pro Formatting & Best Practice Tips

Adding before/after screenshots or GIFs speeds up UI pull request approval by over 50%.
Explicitly state whether database schema migrations are introduced.

Recommended DocSwift Tools for This Workflow

Code to Image Converter - Create Beautiful Code Snippet Graphics (Carbon Alternative)

Frequently Asked Questions

Where does GitHub look for the pull request template?

GitHub automatically looks for `.github/pull_request_template.md` or `docs/pull_request_template.md` in the default branch.

Back to All Templates Convert Markdown to PDF