|
1 | | -# PR Approval Steps |
2 | | - |
3 | | -## For Requester |
4 | | - |
5 | | -1. Description |
6 | | - - [ ] Check the PR title and description for clarity. It should describe the changes made and the reason behind them. |
7 | | - - [ ] Ensure that the PR follows the contribution guidelines, if applicable. |
8 | | -2. Security requirements |
9 | | - - [ ] 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 |
10 | | - - [ ] Ensure commit has GitHub Commit Signature |
11 | | -3. Manual review |
12 | | - 1. Click on the Files changed tab to see the code changes. Review the changes thoroughly: |
13 | | - - [ ] Code Quality: Check for coding standards, naming conventions, and readability. |
14 | | - - [ ] Functionality: Ensure that the changes meet the requirements and that all necessary code paths are tested. |
15 | | - - [ ] Security: Check for any security issues or vulnerabilities. |
16 | | - - [ ] Documentation: Confirm that any necessary documentation (code comments, README updates, etc.) has been updated. |
17 | | -4. Check for Merge Conflicts: |
18 | | - - [ ] Verify if there are any merge conflicts with the base branch. GitHub will usually highlight this. If there are conflicts, you should resolve them. |
19 | | - |
20 | | -## For Reviewer |
21 | | - |
22 | | -1. Go through `For Requester` section to double check each item. |
23 | | -2. Request Changes or Approve the PR: |
24 | | - 1. If the PR is ready to be merged, click Review changes and select Approve. |
25 | | - 2. If changes are required, select Request changes and provide feedback. Be constructive and clear in your feedback. |
26 | | -3. Merging the PR |
27 | | - 1. Check the Merge Method: |
28 | | - 1. Decide on the appropriate merge method based on your repository's guidelines (e.g., Squash and merge, Rebase and merge, or Merge). |
29 | | - 2. Merge the PR: |
30 | | - 1. Click the Merge pull request button. |
31 | | - 2. Confirm the merge by clicking Confirm merge. |
| 1 | +## What's changing and why? |
| 2 | +<!-- Describe what you're changing and the motivation behind it --> |
32 | 3 |
|
| 4 | + |
| 5 | +## Before/After UX |
| 6 | +<!-- Show the user experience before and after your changes --> |
| 7 | +**Before:** |
| 8 | + |
| 9 | + |
| 10 | +**After:** |
| 11 | + |
| 12 | + |
| 13 | +## How was this change tested? |
| 14 | +<!-- Describe your testing approach --> |
| 15 | + |
| 16 | + |
| 17 | +## Unit test coverage |
| 18 | +<!-- Check unit test coverage for your changes --> |
| 19 | +- [ ] All new/modified code has unit tests |
| 20 | +- [ ] Coverage verified for changed code |
| 21 | +- [ ] N/A - no testable code changes |
| 22 | + |
| 23 | +## Do we need integration tests? |
| 24 | +<!-- Consider if integration tests are needed --> |
| 25 | +- [ ] Yes - integration tests added |
| 26 | +- [ ] No - unit tests sufficient |
| 27 | +- [ ] No - infrastructure/config change only |
| 28 | +- [ ] Unsure - please advise |
| 29 | + |
| 30 | +--- |
| 31 | + |
| 32 | +## Checklist |
| 33 | +- [ ] PR title clearly describes the change |
| 34 | +- [ ] No sensitive information exposed and security is maintained |
| 35 | +- [ ] Ready for review |
0 commit comments