Skip to content
Merged
Changes from all commits
Commits
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
20 changes: 20 additions & 0 deletions PR_TEMPLATE/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
## Summary
<!-- Provide 2-3 bullet points summarizing the key changes and their purpose -->
-
-
-

## Changes
<!-- List the specific changes made, grouped by component or functionality -->
- **Component/Feature**: Description of changes
- **Another Component**: Description of changes
-

## Test Plan
<!-- Checklist of tests to validate the changes -->
- [ ] Test item 1
- [ ] Test item 2
- [ ] Test item 3

## Additional Notes
<!-- Any additional context, design decisions, or concerns for reviewers -->
Comment on lines +1 to +20

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

This is a good starting template. To make it more robust and useful for both authors and reviewers, I suggest adding a section for related issues and a self-review checklist for the author. This helps streamline the review process by ensuring all context is provided and preliminary checks are done.

## Summary
<!-- Provide 2-3 bullet points summarizing the key changes and their purpose -->
- 
- 
- 

## Related Issues
<!-- Link to any related issues, e.g., "Closes #123" -->
- 

## Changes
<!-- List the specific changes made, grouped by component or functionality -->
- **Component/Feature**: Description of changes
- **Another Component**: Description of changes
- 

## Test Plan
<!-- Checklist of tests to validate the changes -->
- [ ] Test item 1
- [ ] Test item 2
- [ ] Test item 3

## Author Checklist
- [ ] I have performed a self-review of my own code.
- [ ] My code follows the style guidelines of this project.
- [ ] I have commented my code, particularly in hard-to-understand areas.
- [ ] I have made corresponding changes to the documentation.
- [ ] My changes generate no new warnings.
- [ ] I have added tests that prove my fix is effective or that my feature works.
- [ ] New and existing unit tests pass locally with my changes.

## Additional Notes
<!-- Any additional context, design decisions, or concerns for reviewers -->