docs(CLAUDE.md): warn that harness-injected PR template copies strip HTML comments - #32373
Conversation
Greptile SummaryThis PR extends the PR-writing guidance in
Confidence Score: 5/5Safe to merge — purely additive text change to an agent instructions file with no risk of breaking anything. The change appends one explanatory sentence to an existing paragraph in CLAUDE.md, which is an agent-instruction file, not production code. There is nothing to break, no logic to misread, and the added guidance accurately describes the problem (HTML comment stripping) and its solution (read the file from disk). No files require special attention.
|
| Filename | Overview |
|---|---|
| CLAUDE.md | Single-sentence addition to the PR-body guidance paragraph, warning that agent harnesses may strip HTML comments from injected template copies and instructing agents to read the file from disk before writing a PR body. |
Reviews (1): Last reviewed commit: "docs(CLAUDE.md): warn that harness-injec..." | Re-trigger Greptile
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Merging this PR will degrade performance by 12.75%
Warning Please fix the performance issues or acknowledge them on CodSpeed. Performance Changes
Tip Investigate this regression by commenting Comparing |
ee69a62
into
litellm_internal_staging
Relevant issues
Linear ticket
Pre-Submission checklist
Please complete all items before asking a LiteLLM maintainer to review your PR
@greptileaito re-request a review after pushing changes)Delays in PR merge?
If you're seeing a delay in your PR being merged, ping the LiteLLM Team on Slack (#pr-review).
Screenshots / Proof of Fix
Documentation-only change to CLAUDE.md; there is nothing to run
Type
📖 Documentation
Changes
Extends the CLAUDE.md paragraph about .github/pull_request_template.md with a warning that agent harnesses may strip HTML comments from copies of the template injected into context, and that agents should read the file from disk before writing a PR body
The template's comments carry binding rules (e.g. proof of fix must include the commit hash of both the before and the after runs). A coding agent recently missed that rule because the template copy it received in context had all HTML comments removed; reading the file from disk shows the full rules and prevents this for any contributor's agent, local or cloud