open-webui/.github/pull_request_template.md

65 lines
2.6 KiB
Markdown
Raw Normal View History

# Pull Request Checklist
2024-02-23 19:16:53 +00:00
2024-05-07 08:18:40 +00:00
- [ ] **Target branch:** Pull requests should target the `dev` branch.
2024-02-23 19:16:53 +00:00
- [ ] **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.
2024-04-27 21:28:14 +00:00
- [ ] **Documentation:** Have you updated relevant documentation [Open WebUI Docs](https://github.com/open-webui/docs), or other documentation sources?
2024-02-23 19:16:53 +00:00
- [ ] **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
- [Briefly describe the changes made in this pull request, including any relevant motivation and impact.]
2024-02-23 19:16:53 +00:00
### Added
2024-04-22 07:19:09 +00:00
- [List any new features, functionalities, or additions]
2024-02-23 19:16:53 +00:00
### Changed
- [List any changes, updates, refactorings, or optimizations]
2024-02-23 19:16:53 +00:00
### Deprecated
- [List any deprecated functionality or features that have been removed]
2024-02-23 19:16:53 +00:00
### Removed
- [List any removed features, files, or functionalities]
### Fixed
- [List any fixes, corrections, or bug fixes]
### Security
- [List any new or updated security-related changes, including vulnerability fixes]
### Breaking Changes
- **BREAKING CHANGE**: [List any breaking changes affecting compatibility or functionality]
---
### Additional Information
2024-04-27 21:38:48 +00:00
- [Insert any additional context, notes, or explanations for the changes]
- [Reference any related issues, commits, or other relevant information]