diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 96d9f1b83..92c34b24c 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,33 +1,64 @@ -### Description +## Description -Please provide a brief description of the changes in this PR. Include any relevant context or background information. + -- **What**: Clearly and concisely describe what changes you have made. -- **Why**: Explain the reasoning behind these changes. What problem are you solving? Why is this change necessary? -- **How**: Describe how you implemented these changes. Provide an overview of the approach and any important implementation details. +> [!NOTE] +> **tldr**: -### Changes Made -- **Added**: List new features or files added. -- **Modified**: Describe existing features or files modified. -- **Removed**: Detail features or files that were removed. +### Background - why do we need this PR? -### Related Issues + -Link to any related issues or discussions. Use keywords like "Fixes", "Resolves", or "Closes" to link to issues automatically. +### Overview - what changed? -- Fixes # -- Resolves # -- Closes # + + +### Implementation - how did you implement the changes? + + + + +## Changes Made + + + +### New features or files + + +- -### Breaking changes +### Modified features or files + + +- + +### Removed features or files + + +- + +## Related Issues + + + +- Resolves # -Describe any breaking change. +## Breaking changes + -### Additional Notes and Examples +## Additional Notes and Examples -Include any additional notes or context that reviewers should be aware of, including snippets of code illustrating your new feature. + ---