mirror of
https://github.com/BerriAI/litellm.git
synced 2026-09-15 23:31:29 +00:00
ac18f1407e
PR template: - Make the rubric explicit at the top: link an issue, OR provide a clear problem description + expected vs. actual + visual QA proof. - Add dedicated sections for each piece so the bot has a deterministic shape to read. - Keep the existing 'Linear ticket' section for internal contributors (they're exempt from the auto-triage rubric). Bug report template: - Split 'What happened?' into 'Actual behavior' + 'Expected behavior'. - Make logs/screenshot a required textarea. - Warning banner at the top tells external contributors that incomplete reports will be auto-closed (with re-evaluation on reopen). Feature request template: - Require a concrete use case + example in the motivation field, not just a one-liner pitch. - Same auto-triage warning banner. Co-authored-by: Mateo Wang <mateo-berri@users.noreply.github.com>
98 lines
3.8 KiB
Markdown
98 lines
3.8 KiB
Markdown
<!--
|
|
👋 Hi there — please read before submitting.
|
|
|
|
To keep the review queue healthy for everyone, **external contributions are
|
|
auto-triaged** by an LLM bot ("Agent Shin") on open / reopen. Pull requests that
|
|
do not meet the rubric below are auto-closed with an explanation, and you can
|
|
update + reopen at any time to be re-evaluated.
|
|
|
|
To pass triage, your PR must satisfy AT LEAST ONE of:
|
|
|
|
(A) Link a related GitHub issue (e.g. "Fixes #1234" or "Resolves
|
|
https://github.com/BerriAI/litellm/issues/1234"), OR
|
|
|
|
(B) Provide ALL of the following IN THIS PR DESCRIPTION:
|
|
- A clear problem description (what bug or missing feature this addresses)
|
|
- Expected vs. actual behavior
|
|
- Visual QA proof (before/after screenshots, screen recording, or
|
|
terminal output demonstrating that the fix/feature works end-to-end)
|
|
|
|
PRs also receive a Greptile code review. PRs open for ≥7 days with a Greptile
|
|
Confidence Score below 4/5 are auto-closed; re-request a review from
|
|
@greptileai once you've addressed the feedback and reopen to be re-evaluated.
|
|
|
|
Internal BerriAI contributors are exempt from this auto-triage — fill in the
|
|
Linear ticket section instead.
|
|
-->
|
|
|
|
## Relevant issues
|
|
|
|
<!-- e.g. "Fixes #000". If you have no related issue, fill in the
|
|
"Problem description / Expected vs. Actual / QA proof" sections below. -->
|
|
|
|
## Linear ticket
|
|
|
|
<!-- INTERNAL CONTRIBUTORS ONLY: add the Linear ticket e.g. "Resolves LIT-1234"
|
|
to magically link the Linear ticket to the GitHub PR. External contributors:
|
|
leave this blank and fill in the problem/expected-actual/QA sections below. -->
|
|
|
|
## Problem description
|
|
|
|
<!-- What bug or missing feature does this PR address? One or two paragraphs.
|
|
External contributors: required unless you linked a GitHub issue above. -->
|
|
|
|
## Expected vs. actual behavior
|
|
|
|
<!-- What did you expect to happen? What is happening today (before this PR)?
|
|
External contributors: required unless you linked a GitHub issue above. -->
|
|
|
|
## QA proof
|
|
|
|
<!-- Required for external contributors: include before/after screenshots,
|
|
a screen recording, or terminal/log output that demonstrates the fix or feature
|
|
works end-to-end. For UI changes, before/after screenshots are mandatory.
|
|
For backend changes, terminal output of a passing test or curl command is fine. -->
|
|
|
|
## Pre-Submission checklist
|
|
|
|
**Please complete all items before asking a LiteLLM maintainer to review your PR**
|
|
|
|
- [ ] I have Added testing in the [`tests/test_litellm/`](https://github.com/BerriAI/litellm/tree/main/tests/test_litellm) directory, **Adding at least 1 test is a hard requirement** - [see details](https://docs.litellm.ai/docs/extras/contributing_code)
|
|
- [ ] My PR passes all unit tests on [`make test-unit`](https://docs.litellm.ai/docs/extras/contributing_code)
|
|
- [ ] My PR's scope is as isolated as possible, it only solves 1 specific problem
|
|
- [ ] I have requested a Greptile review by commenting `@greptileai` and received a **Confidence Score of at least 4/5** before requesting a maintainer review
|
|
|
|
## Delays in PR merge?
|
|
|
|
If you're seeing a delay in your PR being merged, ping the LiteLLM Team on [Slack (#pr-review)](https://join.slack.com/t/litellmossslack/shared_invite/zt-3o7nkuyfr-p_kbNJj8taRfXGgQI1~YyA).
|
|
|
|
## CI (LiteLLM team)
|
|
|
|
> **CI status guideline:**
|
|
>
|
|
> - 50-55 passing tests: main is stable with minor issues.
|
|
> - 45-49 passing tests: acceptable but needs attention
|
|
> - <= 40 passing tests: unstable; be careful with your merges and assess the risk.
|
|
|
|
- [ ] **Branch creation CI run**
|
|
Link:
|
|
|
|
- [ ] **CI run for the last commit**
|
|
Link:
|
|
|
|
- [ ] **Merge / cherry-pick CI run**
|
|
Links:
|
|
|
|
## Type
|
|
|
|
<!-- Select the type of Pull Request -->
|
|
<!-- Keep only the necessary ones -->
|
|
|
|
🆕 New Feature
|
|
🐛 Bug Fix
|
|
🧹 Refactoring
|
|
📖 Documentation
|
|
🚄 Infrastructure
|
|
✅ Test
|
|
|
|
## Changes
|