LibreChat/.github
Marco Beretta 8cfa9da00a
📋 docs: Clarify Type of Change and Screenshot Uploads in the PR Template (#16165)
* docs: tighten PR template type-of-change and screenshot guidance

Type of change asked authors to select what applies but left the whole list in
the description, so every PR shipped six unchecked boxes a reviewer had to scan
past. Tell authors to delete the lines that do not apply.

The screenshot section said only "include before/after screenshots", which left
both when it applies and how to attach a file to guesswork. Spell out the
user-visible surfaces that require one, and give the upload path directly:
relative image links in the body plus `gh pr create|edit|comment --attach`,
which rewrites each link to the uploaded asset. Name the workarounds that must
not be used, since a committed image, a local path or a hand-written
user-attachments link all cost a review round.

* docs: tell PR authors not to hand-wrap paragraphs

GitHub renders a single newline inside a paragraph as a line break, so a
description wrapped at 80 columns in an editor arrives as ragged short lines
that never reflow to the reader's window. Say so in the Summary guidance, and
note that it covers every section, list items and table cells.

* docs: stop claiming gh --attach is the only upload route

The web editor's drag and paste is also a real upload and also returns an
asset URL. The point of the sentence is that an asset URL comes back from an
upload and cannot be written by hand, so say that instead.

* docs: say the before screenshot comes from the base revision

"Capture from the app running this branch" applied to both halves of the pair,
so a before image captured that way shows the changed UI too and the pair
demonstrates nothing.
2026-09-21 21:15:53 -04:00
..
ISSUE_TEMPLATE 🆔 feat: Built-in Build Metadata for Support Triage (#12756) 2026-05-23 09:41:13 -04:00
scripts 🎯 ci: Retarget Pull Requests Opened Against main to dev (#15416) 2026-08-31 11:29:34 -04:00
workflows 📒 ci: Upload Per-Test Jest Results From Review Workflows (#16110) 2026-09-20 05:00:29 -04:00
CODE_OF_CONDUCT.md 🔗 chore: Add Stable Discord and Homepage Links (#1835) 2024-02-19 09:42:57 -05:00
configuration-release.json 📜 ci: AutomateCHANGELOG.md (#5838) 2025-02-18 08:35:43 -05:00
configuration-unreleased.json 📜 ci: AutomateCHANGELOG.md (#5838) 2025-02-18 08:35:43 -05:00
CONTRIBUTING.md 🎯 ci: Retarget Pull Requests Opened Against main to dev (#15416) 2026-08-31 11:29:34 -04:00
FUNDING.yml
playwright.yml 🚚 ci: Make Image Publishing Owner-Agnostic Ahead of the Org Move (#15952) 2026-09-14 22:09:59 -04:00
pull_request_template.md 📋 docs: Clarify Type of Change and Screenshot Uploads in the PR Template (#16165) 2026-09-21 21:15:53 -04:00
SECURITY.md ✨ v0.8.8-rc2 (#14845) 2026-09-02 22:18:48 -04:00