* 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.
* 📐 docs: Ask Pull Requests to Show the Mechanism
The template asked for a brief summary and a test process, so descriptions land as a list of changed behavior with no view of how the change works. Reviewers then rebuild the call order from the diff.
Summary now asks for the trigger and the resulting behavior. A new optional How it works section offers four views — a focused diff, a call tree, a shallow file tree, and a Mermaid sequence — with the instruction to pick one or two and delete the section when the summary already covers it. All guidance rides in HTML comments, so an unfilled template renders exactly as it does today.
CLAUDE.md and AGENTS.md carry the same rule for agent-authored descriptions.
Adapted from HumanLayer's show-me skill and an internal ClickHouse PR-template proposal.
* 🧭 docs: Add Review and Completion Standards
Both files describe how to write a change and how to test it, but not how a pull request gets from opened to done. That gap is where review rounds stall: a finding gets patched, the next review runs against an older head, and a working code path ships without its empty, failure or restored-session behavior.
The new Review and Completion section states the review-cycle invariants — inline threads are the source of truth, findings are judged against the code, a review counts only for the commit it ran on, and repeated findings mean the subsystem needs a sweep — followed by a definition of done covering the observable experience, compatibility, and honest reporting of what was actually run.
The reviewer and its trigger phrase are named as the part expected to change, so that subsection can be rewritten without touching the invariants around it. Nothing here restates the existing Testing, Typechecking or Frontend rules; it points at them.
* 🧹 docs: Drop the Shipped Insights Design Note
`docs/agent-insights-access-design.md` was the pre-implementation spec for #15549, and it says so: "design reference for work based on upstream/dev after PR #14898". Everything it specifies shipped — PermissionBits.VIEW_INSIGHTS = 16, /api/insights, the server-owned initial_agent_id — so the code and its tests are the source of truth now and the note can only drift from them. Nothing in the repository links to it.
docs/skills-management-api.md stays: it describes a machine API surface that has no equivalent on librechat.ai, and its details still match packages/api/src/skills/management.ts.
* Rename .github/PULL_REQUEST_TEMPLATE/PULL-REQUEST.md to .github/pull_request_template.md
fix: Pull Request Template Location
* documents -> docs
* Update windows_install.md
Fix: Docker hyperlink
* Update linux_install.md
Fix: Layout (step 6)
* Rename docs/contributions/code_of_conduct.md to CODE_OF_CONDUCT.md
fix: Code of Conduct location according to GitHub's Guide
* Update CODE_OF_CONDUCT.md
Update: Contact info
* Update README.md
Update: Code of Conduct hyperlink in TOC
* Update CODE_OF_CONDUCT.md
Update: Link to ReadMe
* Update CONTRIBUTORS.md
update: add new name to the list
* Update and rename docs/contributions/contributor_guidelines.md to CONTRIBUTING.md
fix: change location according to GitHub's standards
* Delete CONTRIBUTORS.md
delete: contributor.md from root (already present in readme)
* Update SECURITY.md
* Update CONTRIBUTING.md
Update discord link to point to rules
* Update README.md
Update discord link to point to rules
* Update README.md
fix: ToC
2023-05-27 07:03:28 -04:00
Renamed from .github/PULL_REQUEST_TEMPLATE/PULL-REQUEST.md (Browse further)