Skip to content
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

(chore): New PR template #120

Merged
merged 1 commit into from
May 27, 2024
Merged
Show file tree
Hide file tree
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
22 changes: 0 additions & 22 deletions .github/PR_TEMPLATE/pull_request.md

This file was deleted.

39 changes: 39 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
### 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.

### Changes Made

- **Added**: List new features or files added.
- **Modified**: Describe existing features or files modified.
- **Removed**: Detail features or files that were removed.

### Related Issues

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

- Fixes #
- Resolves #
- Closes #

### Breaking changes

Describe any breaking change.


### Additional Notes and Examples

Include any additional notes or context that reviewers should be aware of, including snippets of code illustrating your new feature.

---

**Please ensure your PR meets the following requirements:**

- [ ] Code builds and passes tests locally, including doctests
- [ ] New tests have been added (for bug fixes/features)
- [ ] Pre-commit passes
- [ ] PR to the documentation exists (for bug fixes / features)
Loading