From 84aa045fa0977113bac04380420fd51533c24d04 Mon Sep 17 00:00:00 2001 From: Marco Beretta <81851188+berry-13@users.noreply.github.com> Date: Sat, 19 Sep 2026 16:46:17 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=8B=20chore:=20Restructure=20Pull=20Re?= =?UTF-8?q?quest=20Template=20(#16094)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * chore: restructure pull request template Rewrite the template around the sections reviewers actually need. The header notices become a blockquote, Summary and How it works trade the long prose guidance for short prompts, and the Mermaid, diff, call tree and file tree examples stay as compact format references. Split Testing into a repro description, tested configuration and automated tests, and add Screenshots / recordings and Risk / compatibility sections. Change Type becomes Type of change with refactor, performance, and tests/tooling/CI options, and the checklist drops the items that restate the contributing guide. * chore: prompt for the trigger in the summary section AGENTS.md asks a description to say what breaks, what triggers it and how it behaves after the change, and points at the template for the formats. The rewritten summary prompt dropped the trigger, so a bug fix could be described without the input, state or configuration that reproduces it. * chore: restore the description requirements the rewrite dropped AGENTS.md and CLAUDE.md both state what a description must contain and name this template as where the prompts live, so a prompt this file drops is one an author can omit while following the template. The rewrite lost four: naming the merged pull request behind a regression, the dependency a change needs, picking one or two mechanism views with a sentence each, and showing a whole block where a diff would hide execution order. Also restore the note keeping the Mermaid arrows solid. A dashed arrow spells the HTML comment terminator, which would close the guidance block and print the rest of it in every new description. --- .github/pull_request_template.md | 160 ++++++++++++++++++++----------- 1 file changed, 106 insertions(+), 54 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 088c0ac33c..82997ea8bf 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,39 +1,40 @@ -# Pull Request Template +# Pull Request -⚠️ Before Submitting a PR, Please Review: -- Please ensure that you have thoroughly read and understood the [Contributing Docs](https://github.com/danny-avila/LibreChat/blob/main/.github/CONTRIBUTING.md) before submitting your Pull Request. - -⚠️ Documentation Updates Notice: -- Kindly note that documentation updates are managed in this repository: [librechat.ai](https://github.com/LibreChat-AI/librechat.ai) +> Before submitting, please review the [Contributing Guide](https://github.com/danny-avila/LibreChat/blob/main/.github/CONTRIBUTING.md). +> +> Documentation changes belong in the [LibreChat documentation repository](https://github.com/LibreChat-AI/librechat.ai). ## Summary ## How it works -## Change Type +## Type of change -Please delete any irrelevant options. + -- [ ] Bug fix (non-breaking change which fixes an issue) -- [ ] New feature (non-breaking change which adds functionality) -- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) -- [ ] This change requires a documentation update -- [ ] Translation update +* [ ] Bug fix +* [ ] Feature +* [ ] Refactor +* [ ] Performance improvement +* [ ] Breaking change +* [ ] Documentation +* [ ] Translation +* [ ] Tests / tooling / CI ## Testing -Please describe your test process and include instructions so that we can reproduce your test. If there are any important variables for your testing configuration, list them here. + + +**Tested environments/configuration:** + + + +**Automated tests:** + + + +## Screenshots / recordings + + + +## Risk / compatibility + + ## Checklist -Please delete any irrelevant options. - -- [ ] My code adheres to this project's style guidelines -- [ ] I have performed a self-review of my own code -- [ ] I have commented in any complex areas of my code -- [ ] I have made pertinent documentation changes -- [ ] My changes do not introduce new warnings -- [ ] I have written tests demonstrating that my changes are effective or that my feature works -- [ ] Local unit tests pass with my changes -- [ ] Any changes dependent on mine have been merged and published in downstream modules. -- [ ] A pull request for updating the documentation has been submitted. +* [ ] I reviewed my own changes +* [ ] Relevant tests have been added or updated +* [ ] Existing relevant tests pass +* [ ] The change does not introduce new warnings or errors +* [ ] User-facing or complex behavior is documented where necessary +* [ ] Required dependency changes have been merged/published +* [ ] Required documentation PR: