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

164 lines
4 KiB
Markdown

# Pull Request
> 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
<!--
Briefly explain:
- What problem or limitation exists today?
- What triggers it (input, state, or configuration)?
- What does this PR change?
- What is the resulting behavior?
Keep this focused on the final state of the code rather than the history of the
branch or previous review iterations. Naming the merged pull request that
introduced a regression is the exception: that is history the reader needs.
Link related issues, and name any dependency this change needs:
Fixes #123
Related to #123
Depends on danny-avila/agents#123
-->
## How it works
<!--
Optional. Remove this section if the implementation is already obvious from the
summary and diff.
Explain the mechanism reviewers need to understand. Pick one or two of the views
below, whichever make the change reviewable, and put a sentence beside each rather
than describing every changed file. Show a whole block instead of a diff when most
of it is new, or when the omitted context would hide execution order or ownership.
Focused diff:
```diff
-const parts = content.filter(isText);
-const files = content.filter(isFile);
+const { parts, files } = splitContent(content);
```
Runtime flow:
```text
submitMessage
ask
setMessages
setSubmission # opens the SSE stream
```
Ownership:
```text
packages/api/src/agents/
├── run.ts # builds the run and callbacks
├── tools.ts # resolves tools for the request
└── client.ts # streams provider output
```
Cross-service flow:
```mermaid
sequenceDiagram
participant Client
participant API
participant Provider
Client->>API: POST /api/agents/chat
API->>Provider: stream request
Provider->>API: content parts
API->>Client: SSE events
```
Keep the arrows in this example solid (`->>`). A dashed Mermaid arrow spells the
HTML comment terminator, so it would close this block early and spill the rest of
the guidance into every description. Diagrams you write outside this comment can
use dashed arrows freely.
-->
## Type of change
<!-- Select all that apply. -->
* [ ] Bug fix
* [ ] Feature
* [ ] Refactor
* [ ] Performance improvement
* [ ] Breaking change
* [ ] Documentation
* [ ] Translation
* [ ] Tests / tooling / CI
## Testing
<!--
Describe how you verified the change.
Include only the configuration that matters for reproducing the test.
Example:
1. Start LibreChat with Agents enabled.
2. Create an agent using an Ollama endpoint.
3. Add the Ask User tool.
4. Send a message that triggers the tool.
5. Confirm the question is rendered and the conversation continues after answering.
-->
**Tested environments/configuration:**
<!--
Examples:
- Browser:
- Provider/model:
- Database:
- Feature flags:
- OS:
-->
**Automated tests:**
<!--
Examples:
- `npm run test:client`
- `npm run test:api`
- Added tests in `foo.spec.ts`
Write "Not applicable" when appropriate.
-->
## Screenshots / recordings
<!--
For user-facing changes, include before/after screenshots or a short recording.
Remove this section when not applicable.
-->
## Risk / compatibility
<!--
Optional for small changes.
Call out anything reviewers should pay particular attention to, such as:
- migrations or schema changes
- API/configuration changes
- provider-specific behavior
- backwards compatibility
- performance implications
- security-sensitive behavior
Write "None" when there are no notable risks.
-->
## 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: <!-- link or N/A -->