[PR #1666] [MERGED] Update Pull Request Template to Improve Checklist and Format #20747

New Issue

GiteaMirror · 2026-04-20T03:09:33-05:00

GiteaMirror commented

2026-04-20 03:09:33 -05:00

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/1666
Author: @silentoplayz
Created: 4/22/2024
Status: ✅ Merged
Merged: 4/27/2024
Merged by: @tjbck

Base: dev ← Head: Silentoplayz-update-PR-template.md

📝 Commits (6)

dcb32f7 Update pull_request_template.md
a615308 Update pull_request_template.md
4a53648 Update pull_request_template.md
29c6b25 Update pull_request_template.md
53b277e Update pull_request_template.md
c1b97a7 Update pull_request_template.md

📊 Changes

1 file changed (+24 additions, -6 deletions)

View changed files

📝 .github/pull_request_template.md (+24 -6)

📄 Description

Pull Request Checklist

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, including README, 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:

A revised version of the pull request template has been created to improve the checklist and format. The updated template includes additional fields to ensure that contributors cover essential aspects of their pull requests. The main changes are:

Added "Testing" and "Code Review" checklist items to ensure that contributions meet testing and code review standards.
Included additional fields in the "Description" section to provide context about the changes made, including relevant background information, solutions to problems, and answers to key questions.
Added fields for "Breaking Changes" and "Security" to bring attention to important changes that may impact the project or users.
Reorganized and expanded the "Changelog Entry" section to provide a clear and structured format for summarizing changes.

Motivation:

The previous pull request format was sufficient as it was, but by introducing this new format, I aim to make it easier for contributors to provide complete and accurate information about their changes, streamlining the review process and reducing the likelihood of misunderstandings.

Changelog Entry

Added

Improved pull request template with additional checklist items and fields for better tracking of changes

Fixed

None - this is a documentation-only change

Changed

Reorganized and expanded the pull request template for better tracking of changes and improvements in the checklist

Removed

None - this is a documentation-only change

Security

Updated pull request template to include security-related fields for better tracking of security changes

Breaking Changes

None - no breaking changes are included in this update

Additional Information

Additional fields have been added to the pull request template for better tracking of Changes, Tests, and Code Reviews.
The reorganized and expanded template will improve the quality and transparency of pull requests.

Changes:

The PR template now includes additional checklist items for testing and code review.
The PR template now includes additional changelog entries for security and breaking changes.
The "Description" section includes more fields to provide context about the changes made.
Updated the pull request template file (pull_request_template.md) to reflect the new format.

Additional Information

This PR introduces a new standard for pull request formatting to ensure that contributors provide comprehensive and detailed information about their changes.
The new format is designed to be flexible and adaptable to different types of changes, from bug fixes to new features.

_{🔄 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/1666 **Author:** [@silentoplayz](https://github.com/silentoplayz) **Created:** 4/22/2024 **Status:** ✅ Merged **Merged:** 4/27/2024 **Merged by:** [@tjbck](https://github.com/tjbck) **Base:** `dev` ← **Head:** `Silentoplayz-update-PR-template.md` --- ### 📝 Commits (6) - [`dcb32f7`](https://github.com/open-webui/open-webui/commit/dcb32f78fe0a84100cb18879099e81f89a07a1ef) Update pull_request_template.md - [`a615308`](https://github.com/open-webui/open-webui/commit/a615308111a423e760a3d4dc5a6e9a90a0b36e1e) Update pull_request_template.md - [`4a53648`](https://github.com/open-webui/open-webui/commit/4a536484a69dfed5aa040d9ed3998cf8b25132c8) Update pull_request_template.md - [`29c6b25`](https://github.com/open-webui/open-webui/commit/29c6b253ca28f57c9a74e717e78b15c06fc8d547) Update pull_request_template.md - [`53b277e`](https://github.com/open-webui/open-webui/commit/53b277e575f7d6b4a3481ba06bd6f5f52af5e634) Update pull_request_template.md - [`c1b97a7`](https://github.com/open-webui/open-webui/commit/c1b97a723f611d41d3179b2c1e9ab10e3b8e4cc8) Update pull_request_template.md ### 📊 Changes **1 file changed** (+24 additions, -6 deletions) <details> <summary>View changed files</summary> 📝 `.github/pull_request_template.md` (+24 -6) </details> ### 📄 Description ## Pull Request Checklist - [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, including [README](https://github.com/open-webui/open-webui/blob/main/README.md), [Open WebUI Docs](https://docs.openwebui.com/), 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? ## Description: A revised version of the pull request template has been created to improve the checklist and format. The updated template includes additional fields to ensure that contributors cover essential aspects of their pull requests. The main changes are: * Added "Testing" and "Code Review" checklist items to ensure that contributions meet testing and code review standards. * Included additional fields in the "Description" section to provide context about the changes made, including relevant background information, solutions to problems, and answers to key questions. * Added fields for "Breaking Changes" and "Security" to bring attention to important changes that may impact the project or users. * Reorganized and expanded the "Changelog Entry" section to provide a clear and structured format for summarizing changes. ## Motivation: The previous pull request format was sufficient as it was, but by introducing this new format, I aim to make it easier for contributors to provide complete and accurate information about their changes, streamlining the review process and reducing the likelihood of misunderstandings. ### Changelog Entry ------------------- ### Added * Improved pull request template with additional checklist items and fields for better tracking of changes ### Fixed * None - this is a documentation-only change ### Changed * Reorganized and expanded the pull request template for better tracking of changes and improvements in the checklist ### Removed * None - this is a documentation-only change ### Security * Updated pull request template to include security-related fields for better tracking of security changes ### Breaking Changes * None - no breaking changes are included in this update ### Additional Information * Additional fields have been added to the pull request template for better tracking of Changes, Tests, and Code Reviews. * The reorganized and expanded template will improve the quality and transparency of pull requests. **Changes**: * The PR template now includes additional checklist items for testing and code review. * The PR template now includes additional changelog entries for security and breaking changes. * The "Description" section includes more fields to provide context about the changes made. * Updated the pull request template file (`pull_request_template.md`) to reflect the new format. --- ### Additional Information * This PR introduces a new standard for pull request formatting to ensure that contributors provide comprehensive and detailed information about their changes. * The new format is designed to be flexible and adaptable to different types of changes, from bug fixes to new features. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

GiteaMirror added the pull-request label 2026-04-20 03:09:33 -05:00

GiteaMirror closed this issue

2026-04-20 03:09:34 -05:00

GiteaMirror referenced this issue

2026-04-20 06:06:51 -05:00

[PR #20747] [CLOSED] fix: Use keyword argument for IndicesClient.refresh() for opensearch-py >= 3.0.0 (#20649) #25760

GiteaMirror referenced this issue

2026-04-25 13:38:39 -05:00

[PR #20747] [CLOSED] fix: Use keyword argument for IndicesClient.refresh() for opensearch-py >= 3.0.0 (#20649) #41390

GiteaMirror referenced this issue

2026-04-30 00:55:24 -05:00

[PR #20747] [CLOSED] fix: Use keyword argument for IndicesClient.refresh() for opensearch-py >= 3.0.0 (#20649) #48808