Target branch: Pull requests should target the dev branch.
Description: Briefly describe the changes in this pull request.
Changelog: Ensure a changelog entry following the format of Keep a Changelog is added at the bottom of the PR description.
Documentation: Have you updated relevant documentation 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?
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
This pull request updates our pull request template to include improved labeling and a new changelog format. The changes are designed to make it easier for reviewers to quickly understand the scope and impact of each pull request.
Added
New section for labeling the pull request title with one of several predefined labels (e.g. BREAKING CHANGE, feat, fix, etc.)
Changed
Improved formatting and organization throughout the template
Deprecated
N/A
Removed
N/A
Fixed
N/A
Security
N/A
Breaking Changes
BREAKING CHANGE: N/A
Additional Information
This change is designed to improve the clarity and consistency of our pull requests. It will help reviewers quickly understand the scope and impact of each pull request.
🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.
## 📋 Pull Request Information
**Original PR:** https://github.com/open-webui/open-webui/pull/2196
**Author:** [@silentoplayz](https://github.com/silentoplayz)
**Created:** 5/12/2024
**Status:** ✅ Merged
**Merged:** 5/13/2024
**Merged by:** [@tjbck](https://github.com/tjbck)
**Base:** `dev` ← **Head:** `PR-template-update`
---
### 📝 Commits (1)
- [`8e94db0`](https://github.com/open-webui/open-webui/commit/8e94db0d1b4c85671cc42d0b06dbc42e47cbad6b) Update pull_request_template.md
### 📊 Changes
**1 file changed** (+32 additions, -19 deletions)
<details>
<summary>View changed files</summary>
📝 `.github/pull_request_template.md` (+32 -19)
</details>
### 📄 Description
# Pull Request Checklist
- [x] **Target branch:** Pull requests should target the `dev` branch.
- [x] **Description:** Briefly describe the changes in this pull request.
- [x] **Changelog:** Ensure a changelog entry following the format of [Keep a Changelog](https://keepachangelog.com/) is added at the bottom of the PR description.
- [x] **Documentation:** Have you updated relevant documentation [Open WebUI Docs](https://github.com/open-webui/docs), or other documentation sources?
- [x] **Dependencies:** Are there any new dependencies? Have you updated the dependency versions in the documentation?
- [x] **Testing:** Have you written and run sufficient tests for the changes?
- [x] **Code Review:** Have you self-reviewed your code and addressed any coding standard issues?
- [x] **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
- This pull request updates our pull request template to include improved labeling and a new changelog format. The changes are designed to make it easier for reviewers to quickly understand the scope and impact of each pull request.
### Added
- New section for labeling the pull request title with one of several predefined labels (e.g. BREAKING CHANGE, feat, fix, etc.)
### Changed
- Improved formatting and organization throughout the template
### Deprecated
- N/A
### Removed
- N/A
### Fixed
- N/A
### Security
- N/A
### Breaking Changes
- **BREAKING CHANGE**: N/A
---
### Additional Information
- This change is designed to improve the clarity and consistency of our pull requests. It will help reviewers quickly understand the scope and impact of each pull request.
---
<sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
📋 Pull Request Information
Original PR: https://github.com/open-webui/open-webui/pull/2196
Author: @silentoplayz
Created: 5/12/2024
Status: ✅ Merged
Merged: 5/13/2024
Merged by: @tjbck
Base:
dev← Head:PR-template-update📝 Commits (1)
8e94db0Update pull_request_template.md📊 Changes
1 file changed (+32 additions, -19 deletions)
View changed files
📝
.github/pull_request_template.md(+32 -19)📄 Description
Pull Request Checklist
devbranch.Changelog Entry
Description
Added
Changed
Deprecated
Removed
Fixed
Security
Breaking Changes
Additional Information
🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.