docs: add TLDR section to PR template - #34203
Merged
Merged
Conversation
Contributor
Greptile SummaryThis PR adds a plain-language overview prompt to the pull request template. The main change is:
Confidence Score: 5/5This looks safe to merge.
|
| Filename | Overview |
|---|---|
| .github/pull_request_template.md | Adds a valid TLDR heading and hidden guidance without disrupting the existing template sections. |
Reviews (1): Last reviewed commit: "docs: add TLDR section to PR template" | Re-trigger Greptile
yucheng-berri
approved these changes
Jul 22, 2026
mateo-berri
enabled auto-merge
July 22, 2026 00:50
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
TLDR
Problem this solves:
How it solves it:
Relevant issues
Linear ticket
Pre-Submission checklist
Please complete all items before asking a LiteLLM maintainer to review your PR
@greptileaito re-request a review after pushing changes)Delays in PR merge?
If you're seeing a delay in your PR being merged, ping the LiteLLM Team on Slack (#pr-review).
Screenshots / Proof of Fix
This PR only edits the PR template markdown, so the end-to-end proof is the template itself in use: this PR's own description leads with the new TLDR section filled out as the scaffold prescribes (captured at 4c1f071). After merge, opening https://github.com/BerriAI/litellm/compare and starting a new PR prefills the description with the TLDR section at the top
Type
📖 Documentation
Changes
Adds a TLDR section at the top of .github/pull_request_template.md with prefilled "Problem this solves:" and "How it solves it:" bullet scaffolding. Its comment caps bullets at one line of roughly 10 words and stresses that the section must be extremely human parsable, comprehensible, and readable because its target audience is humans, not AI agents
Final Attestation