diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..237dd4c1 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,42 @@ +## PR Title โœจ + +๐Ÿ“ conforms with the following format: + +- [ ] prefix (following the [convention](https://www.conventionalcommits.org/en/v1.0.0-beta.2/): feat, fix, hotfix, chore, refactor, revert, docs, style, test) +- [ ] issue number (e.g. RSS-ECOMM-1_01, where 1 - is the sprint number and 01 - is the issue number) +- [ ] description + +๐Ÿ‘€ Example: `feat(RSS-ECOMM-1_01): description` + +## PR Decription ๐Ÿง™โ€โ™‚๏ธ + +_Add a description of the changes in the PR_ ๐Ÿค” + +#### Affected Scope ๐Ÿ’ก + +Provide affected modules or areas + +#### Testing Strategy ๐Ÿงผ + +Describe the testing strategy for the changes + +#### Screenshots/Demo ๐Ÿ“ธ + +If necessary provide screenshots or a demo link to visually demonstrate the changes + +#### Documentation Updates ๐Ÿ“– + +Specify if any documentation updates are required and provide details on what needs to be updated + +#### Provide any other relevant information ๐Ÿฆ‰ + +## Self-Check ๐ŸŒŸ + +- [ ] I wrote the correct title for the PR ๐Ÿ—๏ธ +- [ ] I wrote the correct description for the PR ๐Ÿ“œ +- [ ] I have performed a self-review of my own code โœ… +- [ ] I have commented my code where needed ๐Ÿ“ +- [ ] My code is formatted correctly and passes the check ๐ŸŽจ +- [ ] My code passes the tests check โ›“๏ธ +- [ ] My code successfully builds โš™๏ธ +- [ ] I am happy with my PR and ready to merge โค๏ธโ€๐Ÿ”ฅ