Skip to content

Commit

Permalink
chore: Improve PR template
Browse files Browse the repository at this point in the history
  • Loading branch information
jdeschamps committed Jan 27, 2025
1 parent 69b7516 commit 1c3f222
Showing 1 changed file with 49 additions and 18 deletions.
67 changes: 49 additions & 18 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,64 @@
### Description
## Description

Please provide a brief description of the changes in this PR. Include any relevant context or background information.
<!-- This section provides the necessary background and information for reviewers to
understand the code and have the correct mindset when examining changes. -->

- **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**: <!-- Write a one sentence summary. -->
### 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
<!-- What problem are you solving? Describe in a few sentences the state before
this PR. Use code examples if useful. -->

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 #
<!-- What aspects and mechanisms of the code base changed? Describe only the over
arching features. -->

### Implementation - how did you implement the changes?

<!-- How did you solve the issue? Provide code examples if applicable and explain why
you chose this approach. -->


## Changes Made

<!-- This section highlights the important features and files that reviewers should
pay attention to when reviewer. Only list the important files, this is useful for
reviewers to correctly assess how deeply the modifications impact the code base. -->

### New features or files

<!-- List new features or files added. -->
-

### Breaking changes
### Modified features or files

<!-- List important modified features or files. -->
-

### Removed features or files

<!-- List removed features or files. -->
-

## Related Issues

<!-- Link to any related issues or discussions. Use keywords like "Fixes", "Resolves",
or "Closes" to link to issues automatically. -->

- Resolves #

Describe any breaking change.
## Breaking changes

<!-- Describe any breaking changes introduced by this PR. -->

### 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.
<!-- Provide any additional information that will help reviewers understand the
changes. This can be links to documentations, forum posts, past discussions etc. -->

---

Expand Down

0 comments on commit 1c3f222

Please sign in to comment.