mirror of
https://github.com/BerriAI/litellm.git
synced 2026-08-28 05:25:59 +00:00
docs: structure PR template TLDR into problem/solution bullets
This commit is contained in:
parent
06169e8c31
commit
06d2efdd56
1 changed files with 12 additions and 2 deletions
14
.github/pull_request_template.md
vendored
14
.github/pull_request_template.md
vendored
|
|
@ -1,7 +1,17 @@
|
|||
## TLDR
|
||||
|
||||
<!-- In a few plain-language sentences, state 1) the problem being solved and 2) how this PR solves it
|
||||
This section must be extremely human parsable, comprehensible, and readable: its target audience is humans, not AI agents, so skip jargon and implementation minutiae and write it so a reviewer understands the PR from this section alone -->
|
||||
<!-- Fill in the bullets below and keep each one short and concrete
|
||||
This section must be extremely human parsable, comprehensible, and readable: its target audience is humans, not AI agents -->
|
||||
|
||||
Problem this solves:
|
||||
|
||||
- <blah>
|
||||
- ...
|
||||
|
||||
How it solves it:
|
||||
|
||||
- <blah>
|
||||
- ...
|
||||
|
||||
## Relevant issues
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue