Either put the Jira/Issue number in the title, or exclaim "the PM gods hath forsaken me!"
Blocked by (these merge requests need to be reviewed and merged first):
Overall Category:
- 🐛
bugfix(semantic PATCH version bump) - ✨
feature(semantic MINOR version dump) - 💄
style(styling or template changes) - 🚨
test(adding, improving or correcting tests) - 🧹
chore(other and/or automated changes) - 🗣
lang(changes to text content or languages translations) - 🔨
refactor(code improvements that don't change functionality) - 📦
build(changes that affect the build system or external dependencies) - 📚
docs(goal-oriented guides, learning-orntd tutorials, information-orntd references, etc) - 🤖
ci(changes to the CI/CD pipeline or deployment process) - ⚡
perf(performance improvements or debugging investigations) - ⏪
revert(undoing previously committed changes)
Description: a general summary of the merge request and its changes (double points if it's written as a poem).
What type of peer review is being requested?
- Code review
- Manual testing
- Data integrity testing
- Content/spelling/grammar/translations review
- Help with documentation and/or technical writing
- 💉 I crave the validation of your feedback (constructive criticism, pretty please)
Add some notes to the reviewer telling them about the hardships you've gone through, and convince them why your merge request is the bee's knees.
- What criteria/state does the reviewer need to be in to start testing?
- How should the reviewer navigate to the part that needs testing?
- What should the reviewer be looking out for?
- What actions does the reviewer need to perform?
- How would the reviewer verify the changes they're seeing are correct?
Have tests been added to the merge request?
- Yes, changes are covered by tests
- Test coverage is lacking, and I would like assistance from a fresh set of eyes
- No, tests are not needed
- Do dependencies need to be updated?
composer install,npm i, etc. - Do assets need to be rebuilt? How?
- Do database migrations need to be run? (
make migrate) - Are there any new data fixtures?
- Anything else database-related?
-
README.md -
ONBOARDING.md
- Not yet, but this merge request is a ideal candidate to be documented
- Separate merge request:
Post-merge: Any notes regarding anything after the merge request is merged, such as: deployment, or notifying project lead / developers / clients?
Out of scope: Did you have any thoughts or ideas that are out of scope for this particular merge request? Should they be turned into issues, brought up as discussion points for the team, etc?
Bonus: Using a Gif, describe how this merge request made you feel.