scriptoriumadmin/litellm
1
0
Fork 0
mirror of https://github.com/BerriAI/litellm.git synced 2026-11-01 07:03:02 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 129

docs(pr-template): mark the agent-drafted summary with a visible Make me human-readable warning block

Browse source 
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
This commit is contained in:
mateo 2026-10-31 21:36:04 +00:00
parent 890c96facb
commit 4eb7f666a4
1 changed files with 7 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
.github/PULL_REQUEST_TEMPLATE/general.md vendored
View file

@ -9,15 +9,16 @@
<!-- The PR author rewrites this in their own words before asking for review. Being able to sum up the PR in a few
plain sentences proves the author understands what it does, and human-written technical English is far easier
for a reviewer to parse than AI-written English
An AI agent may draft a starting point here, but always wraps its draft in the make-me-human-readable tags below,
backticks included so the tags stay visible on GitHub, so nobody mistakes it for the author's words. The author rewrites it in their own words and deletes the tags.
Tags still present at review time mean the summary is AI-written and has not been rewritten yet
An AI agent may draft a starting point here, but always puts its draft inside the "Make me human-readable" warning
block below so nobody mistakes it for the author's words. The author replaces the whole block with their own
plain-paragraph version. A warning still present at review time means the summary is AI-written and not rewritten yet
Say what the PR does for users and why, then anything that keeps it working over time (a sync job, a config someone owns)
No bullets, tables, or code names here. Everything else goes inside the Details block below -->
`<make-me-human-readable>`
<blah>
`</make-me-human-readable>`
> [!WARNING]
> Make me human-readable. An AI drafted this summary, so rewrite it in your own words to help the reviewer follow what the PR does, then replace this whole block with your version
>
> <blah>
<details>
<summary>Details</summary>