diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index a2ff0baf25..edbc9d98cc 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,33 +1,35 @@ -## Type of change +## 🎟ī¸ Tracking - + -``` -- [ ] Bug fix -- [ ] New feature development -- [ ] Tech debt (refactoring, code cleanup, dependency upgrades, etc) -- [ ] Build/deploy pipeline (DevOps) -- [ ] Other -``` +## 📔 Objective -## Objective + - +## 📸 Screenshots -## Code changes + - - +## ⏰ Reminders before review -- **file.ext:** Description of what was changed and why +- Contributor guidelines followed +- All formatters and local linters executed and passed +- Written new unit and / or integration tests where applicable +- Protected functional changes with optionality (feature flags) +- Used internationalization (i18n) for all UI strings +- CI builds passed +- Communicated to DevOps any deployment requirements +- Updated any necessary documentation (Confluence, contributing docs) or informed the documentation team -## Screenshots +## đŸĻŽ Reviewer guidelines - + -## Before you submit - -- Please add **unit tests** where it makes sense to do so (encouraged but not required) -- If this change requires a **documentation update** - notify the documentation team -- If this change has particular **deployment requirements** - notify the DevOps team -- Ensure that all UI additions follow [WCAG AA requirements](https://contributing.bitwarden.com/contributing/accessibility/) +- 👍 (`:+1:`) or similar for great changes +- 📝 (`:memo:`) or ℹī¸ (`:information_source:`) for notes or general info +- ❓ (`:question:`) for questions +- 🤔 (`:thinking:`) or 💭 (`:thought_balloon:`) for more open inquiry that's not quite a confirmed issue and could potentially benefit from discussion +- 🎨 (`:art:`) for suggestions / improvements +- ❌ (`:x:`) or ⚠ī¸ (`:warning:`) for more significant problems or concerns needing attention +- 🌱 (`:seedling:`) or â™ģī¸ (`:recycle:`) for future improvements or indications of technical debt +- ⛏ (`:pick:`) for minor or nitpick changes