generated from amazon-archives/__template_Apache-2.0
-
Notifications
You must be signed in to change notification settings - Fork 37
chore: improve PR template #171
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.
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
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| ## Description | ||
|
|
||
| ### Why is this change being made? | ||
|
|
||
| 1. | ||
|
|
||
|
|
||
| ### What is changing? | ||
|
|
||
| 1. | ||
|
|
||
|
|
||
| ### Related Links | ||
| - **Ticket/Issue**: | ||
| - **Design Doc**: | ||
|
|
||
| --- | ||
|
|
||
| ## Revision History | ||
|
|
||
| <!-- Create a new entry in this section when publishing new revisions. Leave blank for Revision 1. --> | ||
|
|
||
| ### Revision X: | ||
|
|
||
| #### What has changed since the last revision? | ||
|
|
||
| 1. | ||
|
|
||
| --- | ||
|
|
||
| ## Testing | ||
|
|
||
| ### How was this tested? | ||
|
|
||
| 1. | ||
|
|
||
|
|
||
| ### When testing locally, provide testing artifact(s): | ||
|
|
||
| 1. | ||
|
|
||
| --- | ||
|
|
||
| ## Reviewee Checklist | ||
|
|
||
| **Update the checklist on each revision:** | ||
|
|
||
| - [ ] I have reviewed, tested and understand all changes | ||
|
|
||
| *If not, why:* | ||
| - [ ] I have filled out the Description and Testing sections above | ||
|
|
||
| *If not, why:* | ||
| - [ ] I have updated the Revision History section (if publishing a new revision) | ||
|
|
||
| *If not, why:* | ||
| - [ ] Build and Unit tests are passing | ||
|
|
||
| *If not, why:* | ||
| - [ ] Unit test coverage for changes is adequate (> 80%) | ||
|
|
||
| *If not, why:* | ||
| - [ ] Integration tests pass locally | ||
|
|
||
| *If not, why:* | ||
| - [ ] I have updated integration tests (if needed) | ||
|
|
||
| *If not, why:* | ||
| - [ ] I have ensured no sensitive information is leaking (i.e., no logging of sensitive fields, or otherwise) | ||
|
|
||
| *If not, why:* | ||
| - [ ] I have added explanatory comments for complex logic, new classes/methods and new tests | ||
|
|
||
| *If not, why:* | ||
| - [ ] I have updated README/documentation (if needed) | ||
|
|
||
| *If not, why:* | ||
| - [ ] I have clearly called out breaking changes (if any) | ||
|
|
||
| *If not, why:* | ||
|
|
||
| --- | ||
|
|
||
| ## Reviewer Checklist | ||
|
|
||
| **All reviewers please ensure the following are true before reviewing each revision:** | ||
|
|
||
| - Reviewee checklist has been accurately filled out | ||
| - Code changes align with stated purpose in description | ||
| - Test coverage adequately validates the changes | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,67 @@ | ||
| *Issue #, if available:* | ||
| ## Description | ||
|
|
||
| *Description of changes:* | ||
| ### Why is this change being made? | ||
|
|
||
| 1. | ||
|
|
||
|
|
||
| ### What is changing? | ||
|
|
||
| 1. | ||
|
|
||
|
|
||
| ### Related Links | ||
| - **Issue #, if available**: | ||
|
|
||
| --- | ||
|
|
||
| ## Testing | ||
|
|
||
| ### How was this tested? | ||
|
|
||
| 1. | ||
|
|
||
| ### When testing locally, provide testing artifact(s): | ||
|
|
||
| 1. | ||
|
|
||
| --- | ||
|
|
||
| ## Reviewee Checklist | ||
|
|
||
| **Update the checklist after submitting the PR** | ||
|
|
||
| - [ ] I have reviewed, tested and understand all changes | ||
| *If not, why:* | ||
| - [ ] I have filled out the Description and Testing sections above | ||
| *If not, why:* | ||
| - [ ] Build and Unit tests are passing | ||
| *If not, why:* | ||
| - [ ] Unit test coverage check is passing | ||
| *If not, why:* | ||
| - [ ] Integration tests pass locally | ||
| *If not, why:* | ||
| - [ ] I have updated integration tests (if needed) | ||
| *If not, why:* | ||
| - [ ] I have ensured no sensitive information is leaking (i.e., no logging of sensitive fields, or otherwise) | ||
| *If not, why:* | ||
| - [ ] I have added explanatory comments for complex logic, new classes/methods and new tests | ||
| *If not, why:* | ||
| - [ ] I have updated README/documentation (if needed) | ||
| *If not, why:* | ||
| - [ ] I have clearly called out breaking changes (if any) | ||
| *If not, why:* | ||
|
|
||
| --- | ||
|
|
||
| ## Reviewer Checklist | ||
|
|
||
| **All reviewers please ensure the following are true before reviewing:** | ||
|
|
||
| - Reviewee checklist has been accurately filled out | ||
| - Code changes align with stated purpose in description | ||
| - Test coverage adequately validates the changes | ||
|
|
||
| --- | ||
|
|
||
| By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.