From 73c3ef1cf6b8a7be599adfd745033e521b397eae Mon Sep 17 00:00:00 2001 From: Robson Date: Wed, 24 Jan 2024 16:12:46 -0300 Subject: [PATCH] feat: add pull request template --- .github/PULL_REQUEST_TEMPLATE.md | 71 ++++++++++++++++++++++++++++++++ 1 file changed, 71 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..3434e5a --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,71 @@ + + +# Main contribution in this PR + +Describe as an item list what are the main contributions found in this PR. + +- [x] Add a new method... +- [x] Fix bugs related to... + +# Github issue + +If this references a Github Issue, please provide it here. Note that github automatically creates a link to an Issue if +it is referenced by number with a leading '#'. + +Issue #1 + + +## Screenshots + + +## How to test + + + +## Emojis + +Emojis can be added to review comments to separate blocking and non-blocking comments. + +Example: Compliments, small suggestions or questions that don't block a merge. + +> 🟢 Liked the refactor! + +> 🟡 Why was this value removed? + +Example: Blocking feedbacks must be addressed before a merge. + +> 🔴 This change will break an important system flow + +### Examples + +| Type | Examples | Description | +| --- | --- | --- | +| Blocking | 🔴 ❌ 🚨 | Red emojis | +| Non-blocking | 🟡 💡 🤔 💭 | Yellow emojis, pensive, etc | +| Compliment | 🟢 💚 😍 👍 🙌 | Green emojis, hearts, positives, etc |