From e4273e726c4b3cc9f64211b6c6c182fd57e55d4a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rafa=C5=82=20Wi=C4=99cek?= Date: Thu, 16 Jan 2025 10:48:29 +0100 Subject: [PATCH 1/2] docs: add pull request template for consistency --- .github/PULL_REQUEST_TEMPLATE.md | 14 ++++++++++++++ 1 file changed, 14 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 000000000..c34f0c52f --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,14 @@ +## Description + +Provide a brief summary of the changes made, including any issues resolved. Include the purpose and context behind these updates. + +## How to test it? + +You can remove this section if this is not a feature branch. +Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Also, list any relevant details for your test configuration. + +## Checklist + +- [ ] I have performed a self-review of my own code. +- [ ] I have made corresponding changes to the documentation, if relevant. +- [ ] I have added tests that prove my fix is effective / my feature works. From e43f6104c12996c9f0f627e348a415f215d893b4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rafa=C5=82=20Wi=C4=99cek?= Date: Thu, 16 Jan 2025 10:49:31 +0100 Subject: [PATCH 2/2] docs: add pull request template for consistency --- .github/PULL_REQUEST_TEMPLATE.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index c34f0c52f..9c05da98a 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -2,13 +2,12 @@ Provide a brief summary of the changes made, including any issues resolved. Include the purpose and context behind these updates. -## How to test it? +## Testing -You can remove this section if this is not a feature branch. -Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Also, list any relevant details for your test configuration. +Explain how the changes can be tested. ## Checklist -- [ ] I have performed a self-review of my own code. -- [ ] I have made corresponding changes to the documentation, if relevant. -- [ ] I have added tests that prove my fix is effective / my feature works. +- [ ] Conducted a self-review of the code changes. +- [ ] Updated documentation, if necessary. +- [ ] Added tests to validate the functionality or fix.