Add "Screenshots / Proof of Fix" section to PR template#25564
Add "Screenshots / Proof of Fix" section to PR template#25564krrish-berri-2 merged 1 commit intomainfrom
Conversation
Co-authored-by: Krrish Dholakia <krrish-berri-2@users.noreply.github.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Greptile SummaryThis PR adds a "Screenshots / Proof of Fix" section to the GitHub PR template, prompting contributors to include visual or log-based evidence of their changes. The new section is well-placed and aligns with the repository's existing rule that PRs claiming to fix issues should include evidence of resolution. Confidence Score: 5/5Safe to merge — documentation-only template change with no code impact. Single-file template addition with no logic, no security surface, and no regressions possible. Aligns with the team's existing rule on requiring proof-of-fix evidence. No files require special attention.
|
| Filename | Overview |
|---|---|
| .github/pull_request_template.md | Adds a "Screenshots / Proof of Fix" section between the CI checklist and Type selector; comment-only guidance with no required checkbox, making it optional for contributors. |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[Contributor opens PR] --> B[Fill out Relevant Issues]
B --> C[Complete Pre-Submission Checklist]
C --> D[CI Links — LiteLLM team]
D --> E["📸 Screenshots / Proof of Fix (NEW)"]
E --> F[Select PR Type]
F --> G[Describe Changes]
G --> H[Maintainer Review]
Reviews (1): Last reviewed commit: "Add Screenshots / Proof of Fix section t..." | Re-trigger Greptile
Relevant issues
Prompted by Slack discussion about ensuring contributors demonstrate their fixes work.
Changes
Adds a new "Screenshots / Proof of Fix" section to the GitHub pull request template (
.github/pull_request_template.md).The section prompts contributors to include visual or log-based evidence that their changes work as expected, with guidance for different PR types:
The section is placed between the CI checklist and the Type selector, so contributors encounter it naturally while filling out the template.
Slack Thread