Merge pull request #1666 from Silentoplayz/Silentoplayz-update-PR-template.md

Update Pull Request Template to Improve Checklist and Format
This commit is contained in:
Timothy Jaeryang Baek 2024-04-27 14:28:44 -07:00 committed by GitHub
commit 1c14b54eb9
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -2,14 +2,16 @@
- [ ] **Description:** Briefly describe the changes in this pull request.
- [ ] **Changelog:** Ensure a changelog entry following the format of [Keep a Changelog](https://keepachangelog.com/) is added at the bottom of the PR description.
- [ ] **Documentation:** Have you updated relevant documentation?
- [ ] **Documentation:** Have you updated relevant documentation [Open WebUI Docs](https://github.com/open-webui/docs), or other documentation sources?
- [ ] **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?
- [ ] **Code Review:** Have you self-reviewed your code and addressed any coding standard issues?
---
## Description
[Insert a brief description of the changes made in this pull request]
[Insert a brief description of the changes made in this pull request, including any relevant motivation and impact.]
---
@ -17,16 +19,32 @@
### Added
- [List any new features or additions]
- [List any new features, functionalities, or additions]
### Fixed
- [List any fixes or corrections]
- [List any fixes, corrections, or bug fixes]
### Changed
- [List any changes or updates]
- [List any changes, updates, refactorings, or optimizations]
### Removed
- [List any removed features or files]
- [List any removed features, files, or deprecated functionalities]
### Security
- [List any new or updated security-related changes, including vulnerability fixes]
### Breaking Changes
- [List any breaking changes affecting compatibility or functionality]
---
### Additional Information
* [Insert any additional context, notes, or explanations for the changes]
* [Reference any related issues, commits, or other relevant information]