diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 665f8456f0b..b93e4add9a7 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -23,30 +23,56 @@ body: label: What happened? description: Also tell us, what did you expect to happen? placeholder: Tell us what you see! - value: "A bug happened!" validations: required: true - type: textarea - id: steps-to-reproduce + id: user-flow attributes: - label: Steps to Reproduce - description: Please provide a numbered list of the exact steps to reproduce this bug (include a curl/python snippet to reproduce it). Number each step (1., 2., 3., ...) in the order you performed them. + label: User Flow + description: | + Two ordered lists, "Before a (hypothetical) fix" and "After a (hypothetical) fix", walking the same end user through the same task, written strictly from that user's seat. Every rule below applies. + + - Describe the real application and the routes its users actually hit, not a generic scenario + - Lead each list with one plain sentence saying where the flow fails (before) or would succeed (after), then number the steps + - Every step is something the user does or observes: the HTTP method and full URL they hit, what they sent, and what visibly came back (status code, error text, the shape of an ID). UI steps name the page URL and what is on screen + - No LiteLLM internals: never name functions, files, DB tables, config classes, hooks, callbacks, or code paths. "The upload hands back an ID that looks like OpenAI's own `file-abc123` instead of the scrambled one the gateway returned" is right, "no managed-file row was registered" is wrong + - Keep the two lists step-for-step identical until they diverge, so the broken step is obvious + - If the bug has a security or authorization consequence, end each list with what another user can do that they shouldn't be able to, and what they could no longer do after a fix placeholder: | - 1. config.yaml file/ .env file/ etc. - 2. Run the following code... - 3. Observe the error... - value: | - 1. - 2. - 3. + Before a (hypothetical) fix: a developer whose app streams chat completions gets no token counts back, so their cost dashboard reads zero + + 1. They send POST https://litellm-domain/v1/chat/completions with "stream": true and no stream_options + 2. The last SSE chunk arrives with "usage": null, so their app records 0 prompt and 0 completion tokens + 3. They open https://litellm-domain/ui/?page=logs and see the request logged at $0 spend + + After a (hypothetical) fix: the same request comes back with real token counts, so the dashboard shows real spend + + 1. The proxy admin sets always_include_stream_usage: true and restarts the proxy + 2. The developer sends the same POST https://litellm-domain/v1/chat/completions with "stream": true and no stream_options + 3. The last SSE chunk now carries a usage object with real prompt and completion token counts + 4. https://litellm-domain/ui/?page=logs shows that request at non-zero spend validations: required: true - type: textarea - id: logs + id: proof-of-bug attributes: - label: Relevant log output - description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. - render: shell + label: Proof the bug occurs + description: | + The commands (e.g., curl) and their full output, screenshots, or a screen recording demonstrating that the bug happens. Every rule below applies. + + - The proof must be completely e2e with no mocks, against a live proxy you ran yourself (e.g., `litellm --config config.yaml --detailed_debug` on localhost:4000), hitting real LLM provider APIs, costing real $ if needed, where the bug involves a provider call. `pytest` commands are not enough + - Show exactly what the end user sees or does, matching the User Flow above step for step + - Start with the config.yaml (or SDK setup) and any env vars the proxy ran with, then the exact version or commit hash the proof was captured at, so a maintainer can stand up the same proxy before running your commands. Keep the real values for env vars that aren't sensitive, they are often the reason the bug happens, and redact only the secrets: never paste a real API key, virtual key, database URL, or other credential, here or anywhere else in the issue + - If the bug applies to more than one of the LLM endpoints (/v1/responses, /v1/chat/completions, /v1/messages), include proof for every one of them, not just one + - For UI bugs: include screenshots and the page URLs you were on. Scrub keys and tokens out of screenshots too (for example, the virtual key is briefly shown in the panel right after you create a virtual key) + placeholder: | + Config / setup the proxy ran with: + + Version or commit: + + Commands and their full output: + validations: + required: true - type: dropdown id: component attributes: diff --git a/.github/scripts/triage_with_llm.py b/.github/scripts/triage_with_llm.py index d2536058e01..a7bd145dbc8 100644 --- a/.github/scripts/triage_with_llm.py +++ b/.github/scripts/triage_with_llm.py @@ -582,7 +582,9 @@ def build_issue_prompt(*, title: str, body: str) -> str: Commands whose external dependencies (LLM provider, DB, network) are mocked or stubbed do NOT count. Prose-only "steps to reproduce" with no run output, video, or - screenshot do NOT satisfy (1). + screenshot do NOT satisfy (1). An unfilled template scaffold + (bare headings such as "Version or commit:" with nothing under + them, empty numbered lists) counts as absent, not as evidence. (2) Expected vs. actual behavior (`has_expected_vs_actual`). FAIL the bug report if either (1) or (2) is missing. Do not bias diff --git a/CLAUDE.md b/CLAUDE.md index 436fa33fa41..0e63b86036d 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -31,6 +31,8 @@ When creating PRs, don't set base to `main`. `litellm_internal_staging` is the d When writing a PR body, treat the comments and imperative instructions inside @.github/pull_request_template.md as rules to follow, not just layout. Agent harnesses may strip HTML comments from copies of that file injected into context, so read .github/pull_request_template.md from disk before writing a PR body to make sure you see every comment rule +Same applies for filing bug reports and .github/ISSUE_TEMPLATE/bug_report.yml + If you're resolving a linear ticket, in the "## Linear ticket" section of the PR, say "Resolves LIT-1234", replacing "LIT-1234" with the actual ticket id that you're resolving. If you don't have the ticket id, don't make one up or search for it. Just leave the section blank Never use `pytest` commands or the like as "Screenshots / Proof of Fix". We prefer curl'ing a live proxy instance running on localhost:4000 (I like to run it with `python litellm/proxy/proxy_cli.py --config litellm/proxy/dev_config.yaml --detailed_debug --reload --use_v2_migration_resolver 2>&1 | tee litellm.log`; the Admin UI dev server is `npm run dev` in `ui/litellm-dashboard`, served on port 3000) and showing both the command run and the output. Also, it should hit real LLM provider APIs, not mocks, and cost real $$$ because that is the most realistic test. The proof of fix should be exactly what the end user / customer would see / do. The run logs in PR #27703 is a prime example of how to do it (not a huge fan of using a python test script that future me and the team will have no visibility into; I prefer just curl commands or a short list of bash commands (e.g., using `for`)). If it's a UI thing, just tell me which URLs to go to (e.g., http://localhost:4000/ui/?page=logs), where to click, what fields to fill out, etc. along with the other commands to run in an ordered list, and I'll do it myself and post the screenshots after you make the PR diff --git a/tests/test_litellm/test_github_triage_with_llm.py b/tests/test_litellm/test_github_triage_with_llm.py index f50cf126c36..300fd7c0710 100644 --- a/tests/test_litellm/test_github_triage_with_llm.py +++ b/tests/test_litellm/test_github_triage_with_llm.py @@ -672,6 +672,11 @@ class TestBuildPrompts: assert "mocked or stubbed" in normalized # Prose-only steps are explicitly insufficient now. assert "steps to reproduce" in normalized + # An unedited issue-form scaffold must not read as evidence: the proof + # field ships with visible headings, so the judge has to be told that + # bare headings with nothing under them count as absent. + assert "unfilled template scaffold" in normalized + assert "counts as absent, not as evidence" in normalized def test_should_not_crash_when_pr_body_contains_curly_braces(self, triage_module): """User-supplied content with `{` / `}` must NOT be re-parsed by