Skip to content

docs(CLAUDE.md): warn that harness-injected PR template copies strip HTML comments - #32373

Merged
mateo-berri merged 1 commit into
litellm_internal_stagingfrom
litellm_claude_md_pr_template_comments
Jul 7, 2026
Merged

docs(CLAUDE.md): warn that harness-injected PR template copies strip HTML comments#32373
mateo-berri merged 1 commit into
litellm_internal_stagingfrom
litellm_claude_md_pr_template_comments

Conversation

@mateo-berri

Copy link
Copy Markdown
Contributor

Relevant issues

Linear ticket

Pre-Submission checklist

Please complete all items before asking a LiteLLM maintainer to review your PR

  • I have added meaningful tests
  • My PR passes all CI/CD checks (e.g., lint, format, unit tests)
  • My PR's scope is as isolated as possible; it only solves 1 specific problem
  • I have received a Greptile Confidence Score of at least 4/5 before requesting a maintainer review (Greptile reviews automatically once the PR is opened; only comment @greptileai to 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

@greptile-apps

greptile-apps Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR extends the PR-writing guidance in CLAUDE.md by one sentence that warns coding agents that harness-injected copies of the pull request template may have HTML comments stripped, and instructs agents to read .github/pull_request_template.md directly from disk before writing a PR body.

  • Adds a single sentence to the existing CLAUDE.md paragraph about treating template instructions as rules, explaining the HTML-comment-stripping issue and its mitigation.
  • No code, tests, or configuration files are affected; the change is confined entirely to CLAUDE.md.

Confidence Score: 5/5

Safe 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.

Important Files Changed

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

codecov Bot commented Jul 7, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@codspeed-hq

codspeed-hq Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Merging this PR will degrade performance by 12.75%

❌ 1 regressed benchmark
✅ 29 untouched benchmarks

Warning

Please fix the performance issues or acknowledge them on CodSpeed.

Performance Changes

Benchmark BASE HEAD Efficiency
test_completion_simple_message 4.2 ms 4.8 ms -12.75%

Tip

Investigate this regression by commenting @codspeedbot fix this regression on this PR, or directly use the CodSpeed MCP with your agent.


Comparing litellm_claude_md_pr_template_comments (16ac40f) with litellm_internal_staging (b8248a2)

Open in CodSpeed

@mateo-berri
mateo-berri merged commit ee69a62 into litellm_internal_staging Jul 7, 2026
124 of 125 checks passed
@mateo-berri
mateo-berri deleted the litellm_claude_md_pr_template_comments branch July 7, 2026 21:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants