[PR #20872] [MERGED] docs: update pr template with critical checks and improve guidelines #48853

New Issue

GiteaMirror · 2026-04-30T01:02:06-05:00

GiteaMirror commented

2026-04-30 01:02:06 -05:00

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/20872
Author: @Th3Un1q3
Created: 1/22/2026
Status: ✅ Merged
Merged: 1/22/2026
Merged by: @tjbck

Base: dev ← Head: docs/actionable_pr_template

📝 Commits (3)

5376b94 docs: update pull request template with critical checks and improved guidelines
2a6e5fb Update .github/pull_request_template.md
70221f1 docs: solidify pr checklist definitions and statements

📊 Changes

1 file changed (+19 additions, -5 deletions)

View changed files

📝 .github/pull_request_template.md (+19 -5)

📄 Description

Pull Request Checklist

Note to first-time contributors: Please open a discussion post in Discussions to discuss your idea/fix with the community before creating a pull request, and describe your changes before submitting a pull request.

This is to ensure large feature PRs are discussed with the community first, before starting work on it. If the community does not want this feature or it is not relevant for Open WebUI as a project, it can be identified in the discussion before working on the feature and submitting the PR.

Before submitting, make sure you've checked the following:

Target branch: Verify that the pull request targets the dev branch. Not targeting the dev branch will lead to immediate closure of the PR.
Description: Provide a concise description of the changes made in this pull request down below.
Changelog: Ensure a changelog entry following the format of Keep a Changelog is added at the bottom of the PR description.
Documentation: If necessary, update relevant documentation Open WebUI Docs like environment variables, the tutorials, or other documentation sources.
Dependencies: Are there any new dependencies? Have you updated the dependency versions in the documentation?
Testing: Perform manual tests to verify the implemented fix/feature works as intended AND does not break any other functionality. Take this as an opportunity to make screenshots of the feature/fix and include it in the PR description.
Agentic AI Code: Confirm this Pull Request is not written by any AI Agent or has at least gone through additional human review AND manual testing. If any AI Agent is the co-author of this PR, it may lead to immediate closure of the PR.
Code review: Have you performed a self-review of your code, addressing any coding standard issues and ensuring adherence to the project's coding standards?
Title Prefix: To clearly categorize this pull request, prefix the pull request title 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

Add concise warnings and checklist items to the PR template to reduce automated rejections and review friction (CLA/branch errors, docs in wrong repo, over-configuration, non-reproducible fixes). These are editorial/template changes only-no production code changes.

Changed

⚠️ Top warning: explicit callouts to target dev, do not delete the CLA, and do not add docs to this repo.
📚 Docs guidance: brief “what to document” and “where to put it” (link to open-webui/docs).
🧭 Design & architecture: require Discussions for large UX/arch changes; prefer smart defaults and local state.
🧪 Testing: ask for reproducible steps and failing test where applicable; test edge cases (URL encoding, HTML entities, type coercion).
🔧 Dependencies: require rationale and compatibility notes for upgrades.
🔁 Git hygiene: encourage atomic PRs and pushing updates to the same branch (avoid close/reopen).
🔐 CLA block protection: explicit inline comment warning not to remove CLA text.

Additional Information

I designed this change after analyzing first-time contributors' mistakes. It aims to boost their success on the first try and cut maintainers' manual effort.

Contributor License Agreement

By submitting this pull request, I confirm that I have read and fully agree to the Contributor License Agreement (CLA), and I am providing my contributions under its terms.

Note

Deleting the CLA section will lead to immediate closure of your PR and it will not be merged in.

_{🔄 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/20872 **Author:** [@Th3Un1q3](https://github.com/Th3Un1q3) **Created:** 1/22/2026 **Status:** ✅ Merged **Merged:** 1/22/2026 **Merged by:** [@tjbck](https://github.com/tjbck) **Base:** `dev` ← **Head:** `docs/actionable_pr_template` --- ### 📝 Commits (3) - [`5376b94`](https://github.com/open-webui/open-webui/commit/5376b94093b912080d34b59d4a9f5a35eb905f7b) docs: update pull request template with critical checks and improved guidelines - [`2a6e5fb`](https://github.com/open-webui/open-webui/commit/2a6e5fbbdfa569dcb1590cb11dbc2a0353d1e5ce) Update .github/pull_request_template.md - [`70221f1`](https://github.com/open-webui/open-webui/commit/70221f1e1347060c63cd080bbd02839f98fa0c68) docs: solidify pr checklist definitions and statements ### 📊 Changes **1 file changed** (+19 additions, -5 deletions) <details> <summary>View changed files</summary> 📝 `.github/pull_request_template.md` (+19 -5) </details> ### 📄 Description # Pull Request Checklist ### Note to first-time contributors: Please open a discussion post in [Discussions](https://github.com/open-webui/open-webui/discussions) to discuss your idea/fix with the community before creating a pull request, and describe your changes before submitting a pull request. This is to ensure large feature PRs are discussed with the community first, before starting work on it. If the community does not want this feature or it is not relevant for Open WebUI as a project, it can be identified in the discussion before working on the feature and submitting the PR. **Before submitting, make sure you've checked the following:** - [X] **Target branch:** Verify that the pull request targets the `dev` branch. **Not targeting the `dev` branch will lead to immediate closure of the PR.** - [X] **Description:** Provide a concise description of the changes made in this pull request down below. - [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:** If necessary, update relevant documentation [Open WebUI Docs](https://github.com/open-webui/docs) like environment variables, the tutorials, or other documentation sources. - [X] **Dependencies:** Are there any new dependencies? Have you updated the dependency versions in the documentation? - [X] **Testing:** Perform manual tests to **verify the implemented fix/feature works as intended AND does not break any other functionality**. Take this as an opportunity to **make screenshots of the feature/fix and include it in the PR description**. - [X] **Agentic AI Code:** Confirm this Pull Request is **not written by any AI Agent** or has at least **gone through additional human review AND manual testing**. If any AI Agent is the co-author of this PR, it may lead to immediate closure of the PR. - [X] **Code review:** Have you performed a self-review of your code, addressing any coding standard issues and ensuring adherence to the project's coding standards? - [X] **Title Prefix:** To clearly categorize this pull request, prefix the pull request title 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 Add concise warnings and checklist items to the PR template to reduce automated rejections and review friction (CLA/branch errors, docs in wrong repo, over-configuration, non-reproducible fixes). These are editorial/template changes only-no production code changes. ### Changed - ⚠️ Top warning: explicit callouts to target dev, do not delete the CLA, and do not add docs to this repo. - 📚 Docs guidance: brief “what to document” and “where to put it” (link to open-webui/docs). - 🧭 Design & architecture: require Discussions for large UX/arch changes; prefer smart defaults and local state. - 🧪 Testing: ask for reproducible steps and failing test where applicable; test edge cases (URL encoding, HTML entities, type coercion). - 🔧 Dependencies: require rationale and compatibility notes for upgrades. - 🔁 Git hygiene: encourage atomic PRs and pushing updates to the same branch (avoid close/reopen). - 🔐 CLA block protection: explicit inline comment warning not to remove CLA text. --- ### Additional Information - I designed this change after analyzing first-time contributors' mistakes. It aims to boost their success on the first try and cut maintainers' manual effort. ### Contributor License Agreement  By submitting this pull request, I confirm that I have read and fully agree to the [Contributor License Agreement (CLA)](https://github.com/open-webui/open-webui/blob/main/CONTRIBUTOR_LICENSE_AGREEMENT), and I am providing my contributions under its terms. > [!NOTE] > Deleting the CLA section will lead to immediate closure of your PR and it will not be merged in. --- <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-30 01:02:06 -05:00

GiteaMirror closed this issue

2026-04-30 01:02:09 -05:00

Sign in to join this conversation.

Branches Tags

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github-starred/open-webui#48853