From 6a3ea14503e5e8f24503e56b32d6d493a20fd908 Mon Sep 17 00:00:00 2001 From: Aleyna <152474292+aleyna-yildizli@users.noreply.github.com> Date: Sun, 22 Sep 2024 20:08:59 +0300 Subject: [PATCH 1/5] docs: create pull request template for standardized submissions --- .../pull_request_template.md | 30 +++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE/pull_request_template.md diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md new file mode 100644 index 00000000..e1b41612 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -0,0 +1,30 @@ +## Pull Request Title Standard +For pull requests, include the issue number and a brief description of the change: +Use `# | prefix followed by the commit type and a concise description`. + +### Description of Changes +(Provide a summary of the changes made in this pull request. Explain why these changes are necessary and how they improve the project.) + +### Related Issue +(Link to the related issue if applicable, e.g., #42) + +### Type of Change +- [ ] Bug Fix +- [ ] New Feature +- [ ] Improvement +- [ ] Documentation Update +- [ ] Other (Please specify) + +### Checklist +- [ ] Documentation updated +- [ ] Tests added +- [ ] Code style adheres to standards +- [ ] Build passes +- [ ] Lint checks pass +- [ ] Relevant issue is linked + +### Additional Notes +(Provide any additional context or comments related to this pull request. For example, discuss any potential impacts on other parts of the codebase, or mention any known issues.) + +### Screenshots (if applicable) +(Include screenshots of the changes if it affects the user interface. This helps reviewers understand the changes better.) From e995e5d85bfa35d4b439caa29f79b0321b2067b2 Mon Sep 17 00:00:00 2001 From: Aleyna <152474292+aleyna-yildizli@users.noreply.github.com> Date: Mon, 23 Sep 2024 13:15:25 +0300 Subject: [PATCH 2/5] imp: Updated PR template for better clarity and adjusted file name casing --- .../PULL_REQUEST_TEMPLATE.md | 31 +++++++++++++++++++ .../pull_request_template.md | 30 ------------------ 2 files changed, 31 insertions(+), 30 deletions(-) create mode 100644 .github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/PULL_REQUEST_TEMPLATE/pull_request_template.md diff --git a/.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..93d994bc --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,31 @@ +## Checklist +Before submitting your pull request, ensure the following: + +### Pull Request Title Standard +- [ ] The pull request title includes the issue number and a brief description of the change. +- [ ] The title follows this format: `# | prefix followed by the commit type and a concise description`. + +### Branch Naming Conventions +- [ ] The branch name follows one of the conventions outlined in the Branch Naming Conventions. + +### Local Testing +- [ ] I have tested my changes locally on Postman, and they are working as expected. + +### Code Quality +- [ ] The code is formatted according to the project's coding guidelines and style. +- [ ] The code has been reviewed to ensure its quality. +- [ ] The code does not contain any issues flagged by SonarLint. + +### Documentation +- [ ] Necessary documentation has been added or existing documentation has been updated, specifically detailing changes made in Postman. + +### Testing +- [ ] Relevant unit tests have been written and included. +- [ ] Relevant integration tests have been written and included. + +### Reviewers and Assignees +- [ ] Default reviewers have been assigned to this pull request. +- [ ] Assignees have been added if necessary. + +### Labels and Associations +- [ ] No specific actions are required in the Labels and Associations section for this pull request. diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md deleted file mode 100644 index e1b41612..00000000 --- a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md +++ /dev/null @@ -1,30 +0,0 @@ -## Pull Request Title Standard -For pull requests, include the issue number and a brief description of the change: -Use `# | prefix followed by the commit type and a concise description`. - -### Description of Changes -(Provide a summary of the changes made in this pull request. Explain why these changes are necessary and how they improve the project.) - -### Related Issue -(Link to the related issue if applicable, e.g., #42) - -### Type of Change -- [ ] Bug Fix -- [ ] New Feature -- [ ] Improvement -- [ ] Documentation Update -- [ ] Other (Please specify) - -### Checklist -- [ ] Documentation updated -- [ ] Tests added -- [ ] Code style adheres to standards -- [ ] Build passes -- [ ] Lint checks pass -- [ ] Relevant issue is linked - -### Additional Notes -(Provide any additional context or comments related to this pull request. For example, discuss any potential impacts on other parts of the codebase, or mention any known issues.) - -### Screenshots (if applicable) -(Include screenshots of the changes if it affects the user interface. This helps reviewers understand the changes better.) From 5428031241f4c505637b9286865453804cee93ce Mon Sep 17 00:00:00 2001 From: Aleyna <152474292+aleyna-yildizli@users.noreply.github.com> Date: Mon, 23 Sep 2024 13:40:04 +0300 Subject: [PATCH 3/5] docs: Update PULL_REQUEST_TEMPLATE.md --- .github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md index 93d994bc..f84b43f3 100644 --- a/.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md @@ -2,9 +2,8 @@ Before submitting your pull request, ensure the following: ### Pull Request Title Standard -- [ ] The pull request title includes the issue number and a brief description of the change. -- [ ] The title follows this format: `# | prefix followed by the commit type and a concise description`. - +- [ ] The pull request title follows the standard: [Pull Request Naming Conventions](CONTRIBUTING.md#pull-request-title-standard). + ### Branch Naming Conventions - [ ] The branch name follows one of the conventions outlined in the Branch Naming Conventions. @@ -20,7 +19,7 @@ Before submitting your pull request, ensure the following: - [ ] Necessary documentation has been added or existing documentation has been updated, specifically detailing changes made in Postman. ### Testing -- [ ] Relevant unit tests have been written and included. +- [ ] Relevant manuel tests have been written and included. - [ ] Relevant integration tests have been written and included. ### Reviewers and Assignees From 5191fd375cba61b0707407866c6fd63983f57ce0 Mon Sep 17 00:00:00 2001 From: Aleyna <152474292+aleyna-yildizli@users.noreply.github.com> Date: Mon, 23 Sep 2024 13:46:16 +0300 Subject: [PATCH 4/5] docs: update link --- .github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md index f84b43f3..0ca61ab7 100644 --- a/.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md @@ -2,10 +2,7 @@ Before submitting your pull request, ensure the following: ### Pull Request Title Standard -- [ ] The pull request title follows the standard: [Pull Request Naming Conventions](CONTRIBUTING.md#pull-request-title-standard). - -### Branch Naming Conventions -- [ ] The branch name follows one of the conventions outlined in the Branch Naming Conventions. +- [ ] The pull request title follows the standard: [Pull Request Naming Conventions](https://github.com/gelecekbilimde/gelecekbilimde-backend/blob/main/CONTRIBUTING.md#pull-request-title-standard). ### Local Testing - [ ] I have tested my changes locally on Postman, and they are working as expected. From 3e533c7294faf3c46b99f7c08f872cf0586fd60b Mon Sep 17 00:00:00 2001 From: Aleyna <152474292+aleyna-yildizli@users.noreply.github.com> Date: Mon, 23 Sep 2024 13:51:28 +0300 Subject: [PATCH 5/5] docs: remove testing --- .github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md index 0ca61ab7..83f0e04f 100644 --- a/.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md @@ -15,12 +15,8 @@ Before submitting your pull request, ensure the following: ### Documentation - [ ] Necessary documentation has been added or existing documentation has been updated, specifically detailing changes made in Postman. -### Testing -- [ ] Relevant manuel tests have been written and included. -- [ ] Relevant integration tests have been written and included. - ### Reviewers and Assignees -- [ ] Default reviewers have been assigned to this pull request. +- [ ] Default reviewers have been assigned to this pull request (all team members). - [ ] Assignees have been added if necessary. ### Labels and Associations