From b0591d2cca72c4238d94db88b1cd8f095636c7a3 Mon Sep 17 00:00:00 2001 From: miroslavpojer Date: Thu, 5 Dec 2024 13:44:04 +0100 Subject: [PATCH 1/2] #58 - Design PR template proposal - Implemented new template for Pull requests. --- .github/pull_request_template.md | 20 ++++++++++++++++++++ 1 file changed, 20 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 00000000..c98ec9ea --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,20 @@ +## Release Notes: +> Provide a concise summary of changes for the release notes. Include any new features, bug fixes, or other significant updates. Keep it brief and to the point. + +## Checklist: +> Ensure the following tasks are completed before submission. +- [ ] My code follows the project style guidelines +- [ ] 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 my feature works +- [ ] New and existing tests pass locally with my changes +- [ ] I have used a code formatting tool to ensure consistent style +- [ ] I have run a linter to check for code quality issues + +## Additional Context: +> Add any other context about the pull request here. + +--- +> **Note:** Remember to link this PR to the related issue by adding `Fixes #issue_number` to the description above. + +Fixes **or** Closes #(issue) From 03dcec8f097eeadc82b4726df46404de52d3be47 Mon Sep 17 00:00:00 2001 From: miroslavpojer Date: Mon, 9 Dec 2024 12:24:22 +0100 Subject: [PATCH 2/2] - Adding dots to the end of sentences. Addressing review comment. --- .github/pull_request_template.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index c98ec9ea..6e2617cb 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -3,13 +3,13 @@ ## Checklist: > Ensure the following tasks are completed before submission. -- [ ] My code follows the project style guidelines -- [ ] 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 my feature works -- [ ] New and existing tests pass locally with my changes -- [ ] I have used a code formatting tool to ensure consistent style -- [ ] I have run a linter to check for code quality issues +- [ ] My code follows the project style guidelines. +- [ ] 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 my feature works. +- [ ] New and existing tests pass locally with my changes. +- [ ] I have used a code formatting tool to ensure consistent style. +- [ ] I have run a linter to check for code quality issues. ## Additional Context: > Add any other context about the pull request here.