PR Template Modify who can merge into main branch #1443

[Acha0203]

closes #1443

For the Submitter

Tasks

• [x] Make sure all checkboxes in the Issue content are checked
• [x] Make sure the PR title is in the format <Issue Title> <Issue Number>
• [x] Make sure "closes (issue number)" is written close to the top
• [x] Attach the enhancement label for update tasks
• [x] Make sure CI completes successfully
• [x] Check everything written in the PR
• [x] Fix the issues pointed out by AI
• [x] Add reviewers
• [x] On Slack, mention the PR reviewer, write your thoughts on the issue, and inform them that the PR has been created

For the Reviewer

Before Reviewing

• [x] Write which PR you are reviewing on Slack

Checks

• [x] Each task for the related issue are written and in checkboxes
• [x] The branch name is close to the issue name
• [x] CI completes successfully
• [x] Changes include only what is necessary for this PR
• [x] Necessary unit tests are implemented
• [x] Necessary E2E tests are implemented
• [x] Perform functionality checks
• [x] If there are any problems, request revisions from the PR submitter and mention them on Slack

After Reviewing

• [x] Leave an approval comment (e.g. LGTM)
• [x] On Slack, mention the PR submitter and a project admin, write which PR you have reviewed, and ask them to merge the PR
• [x] Write an approval comment with praise on Slack

[github-actions[bot]]

Update Summary

The changes occurred in the file .github/pull_request_template.md

.github/pull_request_template.md

• The instructions for after reviewing have been more clearly outlined. The roles and responsibilities of the PR submitter, reviewer, and project admin in the merge process are more clearly defined.
• An additional step has been added for project admins to merge the PR after it has been reviewed and approved.

Suggestions for improvement

.github/pull_request_template.md

• There could be a step added to remind the project admin to delete the branch after the PR is merged to keep the repository clean.

• It would be helpful to add a step for the reviewer to verify that all checks(pass CI/CD pipeline, linting, etc.) have passed before approving the PR.

  by OpenAI

[sonarcloud[bot]]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

[codeclimate[bot]]

Code Climate has analyzed commit 48ae175b and detected 0 issues on this pull request.

View more on Code Climate.

[github-actions[bot]]

Update Summary

The update made changes to two files namely .github/ISSUE_TEMPLATE/custom.md and .github/pull_request_template.md. The changes seem to be aimed at simplifying the respective templates.

.github/ISSUE_TEMPLATE/custom.md

• Removed the checkbox task to share the screen on Discord from the "Before Working on the Issue" section.
• Removed the checkbox task instructing to write on Slack which issue is being started.

.github/pull_request_template.md

• Removed the "Before Reviewing" section which contained the checkbox task to write on Slack which Pull Request is being reviewed.

Suggestions for improvement

.github/ISSUE_TEMPLATE/custom.md

• Add more specific guidelines or steps in the "Before Working on the Issue" section. This will ensure contributors have a clear idea of what to do before starting any issue.
• If real-time collaboration is necessary, consider adding alternative tools for screen sharing or instant messaging.

.github/pull_request_template.md

• Include a step to test the changes in the local environment before starting the review process, as this can help catch issues early.

• If real-time update is a necessity, consider using Git tools that support real-time collaboration or have seamless integration with team communication platforms.

  by OpenAI