mirror of
https://github.com/danny-avila/LibreChat.git
synced 2026-11-16 21:08:17 +00:00
* 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.
6.5 KiB
6.5 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: