Skip to content

Commit

Permalink
chore: Improve PR template
Browse files Browse the repository at this point in the history
  • Loading branch information
kurosakishigure committed Jan 4, 2025
1 parent f61b218 commit e696536
Showing 1 changed file with 25 additions and 13 deletions.
38 changes: 25 additions & 13 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,39 @@
<!-- Thanks for opening a PR! Your contribution is much appreciated.
<!--
Thanks for opening a PR! Your contribution is much appreciated.
To make sure your PR is handled as smoothly as possible we request that you follow the checklist sections below.
Choose the right checklist for the change(s) that you're making:
-->

### Annotation

Signed-off-by: Your Name <Your Email>
Co-authored-by: Your Name <Your Email>

### Description

Please include a summary of the changes and the related issue (if applicable).
<!--
Please include a summary of the changes.
Explain the reason for the changes and any context that might be helpful for the reviewer.
-->

1. summary of changes

- **What is the purpose of this PR?**
- **What problem does it solve?**
- **Are there any breaking changes or backwards compatibility issues?**

### Related Issue

If this PR addresses an existing issue, please provide a reference to it (e.g., "Fixes #123" or "Closes #456").
<!--
If this PR addresses an existing issue, please provide a reference to it.
-->

Example:
- Closes #123
- Fixes #456

### Type of Change

Please delete options that are not relevant:
<!--
Please delete options that are not relevant.
-->

- [ ] Bug fix
- [ ] New feature
Expand All @@ -30,21 +42,21 @@ Please delete options that are not relevant:
- [ ] Add or improve examples
- [ ] Miscellaneous tasks
- [ ] Reverts commit
- [ ] Other (please describe):

### How Has This Been Tested?

<!--
Please describe the tests that you ran to verify your changes.
Include any details about the environment or specific configurations used during testing.
-->

Example:
- [ ] I have run unit tests
- [ ] I have tested the changes manually
- [ ] I have tested in a staging environment

### Checklist

Please check the following before submitting the PR:
<!--
Please check the following before submitting the PR.
-->

- [ ] I have read and followed the guidelines in `CONTRIBUTING.md`
- [ ] I have already updated the related templates accordingly (if applicable)
Expand All @@ -54,6 +66,6 @@ Please check the following before submitting the PR:

### Additional Notes

<!--
Any additional information.
-->

0 comments on commit e696536

Please sign in to comment.