Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weโ€™ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Pull request template enhancements #5

Merged
merged 8 commits into from
Mar 29, 2023
61 changes: 42 additions & 19 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,51 @@
## Type of change
## ๐ŸŽŸ๏ธ Tracking

<!-- (mark with an `X`) -->
<!-- Paste the link to the Jira or GitHub issue or otherwise describe / point to where this change is coming from. -->

```
- [ ] Bug fix
- [ ] New feature development
- [ ] Tech debt (refactoring, code cleanup, dependency upgrades, etc)
- [ ] Build/deploy pipeline (DevOps)
- [ ] Other
```
## ๐Ÿšง Type of change

## Objective
<!-- Choose those applicable and remove the others. -->

<!--Describe what the purpose of this PR is. For example: what bug you're fixing or what new feature you're adding-->
- ๐Ÿ› Bug fix
- ๐Ÿš€ New feature development
- ๐Ÿงน Tech debt (refactoring, code cleanup, dependency upgrades, etc.)
- ๐Ÿค– Build/deploy pipeline (DevOps)
- ๐ŸŽ‚ Other

## Code changes
## ๐Ÿ“” Objective

<!--Explain the changes you've made to each file or major component. This should help the reviewer understand your changes-->
<!--Also refer to any related changes or PRs in other repositories-->
<!-- Describe what the purpose of this PR is, for example what bug you're fixing or new feature you're adding. -->

- **file.ext:** Description of what was changed and why
## ๐Ÿ“‹ Code changes

## Before you submit
<!-- Explain the changes you've made to each file or major component. This should help the reviewer understand your changes. -->
<!-- Also refer to any related changes or PRs in other repositories. -->

- 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
- **file.ext:** Description of what was changed and why.

## ๐Ÿ“ธ Screenshots

<!-- Required for any UI changes; delete if not applicable. Use fixed width images for better display. -->

## โฐ Reminders before review

- 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 or informed the documentation team

## ๐Ÿฆฎ Reviewer guidelines

<!-- Suggested interactions but feel free to use (or not) as you desire! -->

- ๐Ÿ‘ (`:+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