-
Notifications
You must be signed in to change notification settings - Fork 19
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
Update PR description template #472
Merged
Merged
Changes from all commits
Commits
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 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,22 +1,40 @@ | ||
| # PR Type | ||
| # 🔘 PR Type | ||
| What kind of change does this PR introduce? | ||
|
|
||
| <!-- Please check the one that applies to this PR using "x". --> | ||
|
|
||
| - [ ] Bugfix | ||
| - [ ] Enhancement | ||
| - [ ] Code style update (formatting, local variables) | ||
| - [ ] Refactoring (no functional changes, no api changes) | ||
| - [ ] Refactoring (no functional changes, no API changes) | ||
| - [ ] Build related changes | ||
| - [ ] CI related changes | ||
| - [ ] Documentation content changes | ||
| - [ ] Other... Please describe: | ||
|
|
||
| # 📜 Background | ||
| Provide a brief explanation of why this pull request is needed. Include the problem you are solving or the functionality you are adding. Reference any related issues. | ||
|
|
||
| # What is the current behavior? | ||
| (Optional) Resolved: #`Insert issue number` | ||
| Issue Link: #[issue_number] | ||
| Context Link (if applicable): | ||
|
|
||
| # 🔄 Changes | ||
| Enumerate the changes made in this pull request, detailing what has been modified, added, or removed. Include technical details and implications if necessary. | ||
|
|
||
| # What is the new behavior? | ||
| Impact: | ||
| - Explain the broader impact of these changes. | ||
| - How it improves performance, fixes bugs, adds functionality, etc. | ||
|
|
||
| # Screenshot / Video | ||
| # 🖼 Screenshot / 📹 Video | ||
| Include screenshots or a video demonstrating the changes. This is especially helpful for UI changes. | ||
|
|
||
| # ✅ Review checklist | ||
| Please ensure the following are true before merging: | ||
|
|
||
| - [ ] Code Style is consistent with the project guidelines. | ||
| - [ ] Code is readable and well-commented. | ||
| - [ ] No unnecessary or debugging code has been added. | ||
| - [ ] Security considerations have been taken into account. | ||
| - [ ] The change has been manually tested and works as expected. | ||
| - [ ] Breaking changes and their impacts have been considered and documented. | ||
| - [ ] Code does not introduce new technical debt or issues. | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would be good if we could also add what effect this could have within the service so that we think about and document what parts need to be QA'd in case of side effects.