Merge pull request #2196 from Silentoplayz/PR-template-update

style: update pull_request_template.md again
This commit is contained in:
Timothy Jaeryang Baek 2024-05-12 14:26:11 -10:00 committed by GitHub
commit 4bd999af81
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -1,4 +1,4 @@
## Pull Request Checklist # Pull Request Checklist
- [ ] **Target branch:** Pull requests should target the `dev` branch. - [ ] **Target branch:** Pull requests should target the `dev` branch.
- [ ] **Description:** Briefly describe the changes in this pull request. - [ ] **Description:** Briefly describe the changes in this pull request.
@ -7,32 +7,46 @@
- [ ] **Dependencies:** Are there any new dependencies? Have you updated the dependency versions in the documentation? - [ ] **Dependencies:** Are there any new dependencies? Have you updated the dependency versions in the documentation?
- [ ] **Testing:** Have you written and run sufficient tests for the changes? - [ ] **Testing:** Have you written and run sufficient tests for the changes?
- [ ] **Code Review:** Have you self-reviewed your code and addressed any coding standard issues? - [ ] **Code Review:** Have you self-reviewed your code and addressed any coding standard issues?
- [ ] **Label title:** Ensure the pull request title is labeled properly using one of the following:
- **BREAKING CHANGE**: Significant changes that may affect compatibility
- **build**: Changes that affect the build system or external dependencies
- **ci**: Changes to our continuous integration processes or workflows
- **chore**: Refactor, cleanup, or other non-functional code changes
- **docs**: Documentation update or addition
- **feat**: Introduces a new feature or enhancement to the codebase
- **fix**: Bug fix or error correction
- **i18n**: Internationalization or localization changes
- **perf**: Performance improvement
- **refactor**: Code restructuring for better maintainability, readability, or scalability
- **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc.)
- **test**: Adding missing tests or correcting existing tests
- **WIP**: Work in progress, a temporary label for incomplete or ongoing work
--- # Changelog Entry
## Description ### Description
[Insert a brief description of the changes made in this pull request, including any relevant motivation and impact.] - [Briefly describe the changes made in this pull request, including any relevant motivation and impact.]
---
### Changelog Entry
### Added ### Added
- [List any new features, functionalities, or additions] - [List any new features, functionalities, or additions]
### Fixed
- [List any fixes, corrections, or bug fixes]
### Changed ### Changed
- [List any changes, updates, refactorings, or optimizations] - [List any changes, updates, refactorings, or optimizations]
### Deprecated
- [List any deprecated functionality or features that have been removed]
### Removed ### Removed
- [List any removed features, files, or deprecated functionalities] - [List any removed features, files, or functionalities]
### Fixed
- [List any fixes, corrections, or bug fixes]
### Security ### Security
@ -40,12 +54,11 @@
### Breaking Changes ### Breaking Changes
- [List any breaking changes affecting compatibility or functionality] - **BREAKING CHANGE**: [List any breaking changes affecting compatibility or functionality]
--- ---
### Additional Information ### Additional Information
- [Insert any additional context, notes, or explanations for the changes] - [Insert any additional context, notes, or explanations for the changes]
- [Reference any related issues, commits, or other relevant information]
- [Reference any related issues, commits, or other relevant information]