Skip to content

docs: add TLDR section to PR template - #34203

Merged
mateo-berri merged 3 commits into
litellm_internal_stagingfrom
litellm_pr_template_tldr
Jul 22, 2026
Merged

docs: add TLDR section to PR template#34203
mateo-berri merged 3 commits into
litellm_internal_stagingfrom
litellm_pr_template_tldr

Conversation

@mateo-berri

@mateo-berri mateo-berri commented Jul 22, 2026

Copy link
Copy Markdown
Contributor

TLDR

Problem this solves:

  • Reviewers must dig through diffs to learn what a PR does

How it solves it:

  • PR template now opens with problem/solution TLDR bullets
  • A comment caps bullets at one short human-readable line each

Relevant issues

Linear ticket

Pre-Submission checklist

Please complete all items before asking a LiteLLM maintainer to review your PR

  • I have added meaningful tests
  • My PR passes all CI/CD checks (e.g., lint, format, unit tests)
  • My PR's scope is as isolated as possible; it only solves 1 specific problem
  • I have received a Greptile Confidence Score of at least 4/5 before requesting a maintainer review (Greptile reviews automatically once the PR is opened; only comment @greptileai to 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

  • The tests check the right things, including the edge cases, and regressions in the respective real-world customer use-cases are not possible after this PR

@mateo-berri
mateo-berri requested a review from a team July 22, 2026 00:38
@greptile-apps

greptile-apps Bot commented Jul 22, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR adds a plain-language overview prompt to the pull request template. The main change is:

  • Adds a TLDR section asking authors to explain the problem and solution at the top of each PR

Confidence Score: 5/5

This looks safe to merge.

  • No blocking issues found in the changed code.

Important Files Changed

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

@ryan-crabbe-berri ryan-crabbe-berri left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM; thanks!

@mateo-berri
mateo-berri enabled auto-merge July 22, 2026 00:50
@codecov

codecov Bot commented Jul 22, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@mateo-berri
mateo-berri merged commit b2a73d4 into litellm_internal_staging Jul 22, 2026
78 checks passed
@mateo-berri
mateo-berri deleted the litellm_pr_template_tldr branch July 22, 2026 00:57
@codspeed-hq

codspeed-hq Bot commented Jul 22, 2026

Copy link
Copy Markdown
Contributor

Merging this PR will not alter performance

✅ 31 untouched benchmarks


Comparing litellm_pr_template_tldr (4c1f071) with litellm_internal_staging (2b2ae4c)1

Open in CodSpeed

Footnotes

  1. No successful run was found on litellm_internal_staging (e967bc8) during the generation of this report, so 2b2ae4c was used instead as the comparison base. There might be some changes unrelated to this pull request in this report.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants