Skip to content

Update PR template for an improved reviewing experience #235

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zhaoqizqwang merged 1 commit into from
Sep 2, 2025
Merged

Update PR template for an improved reviewing experience #235

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 34 additions & 31 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,32 +1,35 @@
# PR Approval Steps

## For Requester

1. Description
- [ ] Check the PR title and description for clarity. It should describe the changes made and the reason behind them.
- [ ] Ensure that the PR follows the contribution guidelines, if applicable.
2. Security requirements
- [ ] Ensure that a Pull Request (PR) does not expose passwords and other sensitive information by using git-secrets and upload relevant evidence: https://github.com/awslabs/git-secrets
- [ ] Ensure commit has GitHub Commit Signature
3. Manual review
1. Click on the Files changed tab to see the code changes. Review the changes thoroughly:
- [ ] Code Quality: Check for coding standards, naming conventions, and readability.
- [ ] Functionality: Ensure that the changes meet the requirements and that all necessary code paths are tested.
- [ ] Security: Check for any security issues or vulnerabilities.
- [ ] Documentation: Confirm that any necessary documentation (code comments, README updates, etc.) has been updated.
4. Check for Merge Conflicts:
- [ ] Verify if there are any merge conflicts with the base branch. GitHub will usually highlight this. If there are conflicts, you should resolve them.

## For Reviewer

1. Go through `For Requester` section to double check each item.
2. Request Changes or Approve the PR:
1. If the PR is ready to be merged, click Review changes and select Approve.
2. If changes are required, select Request changes and provide feedback. Be constructive and clear in your feedback.
3. Merging the PR
1. Check the Merge Method:
1. Decide on the appropriate merge method based on your repository's guidelines (e.g., Squash and merge, Rebase and merge, or Merge).
2. Merge the PR:
1. Click the Merge pull request button.
2. Confirm the merge by clicking Confirm merge.
## What's changing and why?
<!-- Describe what you're changing and the motivation behind it -->


## Before/After UX
<!-- Show the user experience before and after your changes -->
**Before:**


**After:**


## How was this change tested?
<!-- Describe your testing approach -->


## Unit test coverage
<!-- Check unit test coverage for your changes -->
- [ ] All new/modified code has unit tests
- [ ] Coverage verified for changed code
- [ ] N/A - no testable code changes

## Do we need integration tests?
<!-- Consider if integration tests are needed -->
- [ ] Yes - integration tests added
- [ ] No - unit tests sufficient
- [ ] No - infrastructure/config change only
- [ ] Unsure - please advise

---

## Checklist
- [ ] PR title clearly describes the change
- [ ] No sensitive information exposed and security is maintained
- [ ] Ready for review
Loading