LibreChat/.github/pull_request_template.md
Marco Beretta 84aa045fa0
📋 chore: Restructure Pull Request Template (#16094)
* 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.
2026-09-19 10:46:17 -04:00

4 KiB

Pull Request

Before submitting, please review the Contributing Guide.

Documentation changes belong in the LibreChat documentation repository.

Summary

How it works

Type of change

  • Bug fix
  • Feature
  • Refactor
  • Performance improvement
  • Breaking change
  • Documentation
  • Translation
  • Tests / tooling / CI

Testing

Tested environments/configuration:

Automated tests:

Screenshots / recordings

Risk / compatibility

Checklist

  • 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: