From 1951b9507d6fe8d3895d2c37ad6b89cbda7dcc7b Mon Sep 17 00:00:00 2001 From: Thomas Rittson <31796059+eliykat@users.noreply.github.com> Date: Thu, 5 Sep 2024 08:13:42 +1000 Subject: [PATCH] Update PR template from template repo (#574) --- .github/PULL_REQUEST_TEMPLATE.md | 47 ++++++++++++++++---------------- 1 file changed, 24 insertions(+), 23 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 2f8a5a9e..ca62e033 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,33 +1,34 @@ -## Type of change +## đŸŽŸī¸ Tracking -- [ ] Bug fix -- [ ] New feature development -- [ ] Tech debt (refactoring, code cleanup, dependency upgrades, etc) -- [ ] Build/deploy pipeline (DevOps) -- [ ] Other + -## Objective +## 📔 Objective - + -## Code changes +## 📸 Screenshots - - + -- **file.ext:** Description of what was changed and why +## ⏰ Reminders before review -## Screenshots +- Contributor guidelines followed +- All formatters and local linters executed and passed +- Written new unit and / or integration tests where applicable +- 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 - +## đŸĻŽ Reviewer guidelines -## Testing requirements + - - -## Before you submit - -- [ ] I have checked for **linting** errors (`npm run lint`) (required) -- [ ] I have added **unit tests** where it makes sense to do so (encouraged but not required) -- [ ] This change requires a **documentation update** (notify the documentation team) -- [ ] This change has particular **deployment requirements** (notify the DevOps team) +- 👍 (`:+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