From 1ab0504288a25996758c38a7af38e06c317ec245 Mon Sep 17 00:00:00 2001 From: Daniel Luiz Alves Date: Tue, 24 Jun 2025 01:02:41 -0300 Subject: [PATCH] chore: add pull request template for improved contribution guidelines - Introduced a new pull request template to standardize submissions and enhance clarity for contributors. - The template includes sections for description, related issues, motivation, AI usage, testing, and a checklist to ensure quality and completeness. - Aims to streamline the review process and improve collaboration within the project. --- .github/pull_request_template.md | 56 ++++++++++++++++++++++++++++++++ 1 file changed, 56 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..4bba10f --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,56 @@ +## **๐ŸŽฏ Please make sure you are opening this Pull Request against the `next` branch!** + +## ๐Ÿ“ Description + +Please provide a clear and concise description of the changes introduced by this pull request. + +## ๐Ÿ”— Related Issue(s) + +If this PR fixes or relates to an issue, please link it here (e.g., `Closes #123`). + +## ๐Ÿ’ก Motivation and Context + +Why is this change required? What problem does it solve? + +## ๐Ÿค– Use of Artificial Intelligence (AI) + +The use of AI tools is absolutely welcome and not an issue. For transparency and continuous improvement, please answer the following: + +- Did you use any AI tools (such as GitHub Copilot, ChatGPT, etc.) to help develop this PR? + - [ ] No, this PR was developed without the assistance of AI tools. + - [ ] Yes, AI tools assisted in the development of this PR (please specify which ones and how they were used): + - Tool(s) used: + - Brief description of how AI contributed: +- Was this PR generated entirely by an AI tool (i.e., with minimal human intervention)? + - [ ] No + - [ ] Yes (please provide details): + +## ๐Ÿงช How Has This Been Tested? + +Please describe the tests that you ran to verify your changes. Include details about your test environment, and the test cases you ran. + +## ๐Ÿ“ธ Screenshots (if appropriate) + +Add any relevant screenshots to help explain your changes. + +## ๐Ÿ”„ Types of Changes + +Check the relevant option(s) below: + +- [ ] ๐Ÿ› Bug fix (non-breaking change which fixes an issue) +- [ ] โœจ New feature (non-breaking change which adds functionality) +- [ ] โš ๏ธ Breaking change (fix or feature that would cause existing functionality to change) +- [ ] ๐Ÿ“š Documentation update + +## โœ… Checklist + +- [ ] My code follows the code style of this project +- [ ] I have performed a self-review of my code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have added tests that prove my fix is effective or that my feature works +- [ ] I have added necessary documentation (if appropriate) +- [ ] I have rebased and/or merged on top of the latest `next` branch + +--- + +๐Ÿ™ Thank you for your contribution! \ No newline at end of file