Skip to content

Commit ef216c3

Browse files
authored
Pull request template enhancements (#5)
* Pull request template enhancements * List of change types for selection * Wording for checks * Make change types a list for when there are multiple applicable * Move away from checklist and back to review reminders, now expanded * Comment for indicating reviewer guidelines are optional * Add suggestions and clarify the more severe warnings * Mention fixed width images
1 parent 294e638 commit ef216c3

File tree

1 file changed

+42
-19
lines changed

1 file changed

+42
-19
lines changed

.github/PULL_REQUEST_TEMPLATE.md

+42-19
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,51 @@
1-
## Type of change
1+
## 🎟️ Tracking
22

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

5-
```
6-
- [ ] Bug fix
7-
- [ ] New feature development
8-
- [ ] Tech debt (refactoring, code cleanup, dependency upgrades, etc)
9-
- [ ] Build/deploy pipeline (DevOps)
10-
- [ ] Other
11-
```
5+
## 🚧 Type of change
126

13-
## Objective
7+
<!-- Choose those applicable and remove the others. -->
148

15-
<!--Describe what the purpose of this PR is. For example: what bug you're fixing or what new feature you're adding-->
9+
- 🐛 Bug fix
10+
- 🚀 New feature development
11+
- 🧹 Tech debt (refactoring, code cleanup, dependency upgrades, etc.)
12+
- 🤖 Build/deploy pipeline (DevOps)
13+
- 🎂 Other
1614

17-
## Code changes
15+
## 📔 Objective
1816

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

22-
- **file.ext:** Description of what was changed and why
19+
## 📋 Code changes
2320

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

26-
- Please add **unit tests** where it makes sense to do so (encouraged but not required)
27-
- If this change requires a **documentation update** - notify the documentation team
28-
- If this change has particular **deployment requirements** - notify the DevOps team
24+
- **file.ext:** Description of what was changed and why.
25+
26+
## 📸 Screenshots
27+
28+
<!-- Required for any UI changes; delete if not applicable. Use fixed width images for better display. -->
29+
30+
## ⏰ Reminders before review
31+
32+
- Contributor guidelines followed
33+
- All formatters and local linters executed and passed
34+
- Written new unit and / or integration tests where applicable
35+
- Used internationalization (i18n) for all UI strings
36+
- CI builds passed
37+
- Communicated to DevOps any deployment requirements
38+
- Updated any necessary documentation or informed the documentation team
39+
40+
## 🦮 Reviewer guidelines
41+
42+
<!-- Suggested interactions but feel free to use (or not) as you desire! -->
43+
44+
- 👍 (`:+1:`) or similar for great changes
45+
- 📝 (`:memo:`) or ℹ️ (`:information_source:`) for notes or general info
46+
- ❓ (`:question:`) for questions
47+
- 🤔 (`:thinking:`) or 💭 (`:thought_balloon:`) for more open inquiry that's not quite a confirmed issue and could potentially benefit from discussion
48+
- 🎨 (`:art:`) for suggestions / improvements
49+
- ❌ (`:x:`) or ⚠️ (`:warning:`) for more significant problems or concerns needing attention
50+
- 🌱 (`:seedling:`) or ♻️ (`:recycle:`) for future improvements or indications of technical debt
51+
- ⛏ (`:pick:`) for minor or nitpick changes

0 commit comments

Comments
 (0)