Skip to content

docs(CLAUDE.md): tell agents to read the PR template file themselves - #32383

Open
devin-ai-integration[bot] wants to merge 1 commit into
litellm_internal_stagingfrom
litellm_pr_template_read_from_disk
Open

docs(CLAUDE.md): tell agents to read the PR template file themselves#32383
devin-ai-integration[bot] wants to merge 1 commit into
litellm_internal_stagingfrom
litellm_pr_template_read_from_disk

Conversation

@devin-ai-integration

Copy link
Copy Markdown
Contributor

Relevant issues

Follow-up to #32373

Linear ticket

Pre-Submission checklist

  • 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)

Screenshots / Proof of Fix

Docs-only change to the PR-body guidance in CLAUDE.md; no runtime behavior, so nothing to run

Type

📖 Documentation

Changes

#32373 added a warning that agent harnesses may strip HTML comments from auto-injected copies of the PR template. The concern with keeping that wording is that CLAUDE.md gets injected into everyone's context, so seeding it with the idea of HTML-comment stripping is noise for most readers

This rephrases the rule to just tell the agent to read .github/pull_request_template.md itself with the read file or bash tool before writing a PR body, rather than relying on an auto-@'d copy that may have been trimmed. Same practical outcome (you see every comment rule) without mentioning HTML or harness internals

Link to Devin session: https://app.devin.ai/sessions/75bfafebbb1b47cf80f11669204c7df7
Requested by: @mateo-berri

…p HTML wording

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@mateo-berri mateo-berri self-assigned this Jul 7, 2026
@devin-ai-integration

Copy link
Copy Markdown
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment, CI, and merge conflict monitoring

@mateo-berri
mateo-berri self-requested a review July 7, 2026 21:40
@mateo-berri
mateo-berri enabled auto-merge (squash) July 7, 2026 21:41
@greptile-apps

greptile-apps Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR tightens the PR-body authoring guidance in CLAUDE.md by replacing implementation-detail wording (HTML comment stripping by agent harnesses) with a simpler, direct instruction for agents to read .github/pull_request_template.md themselves using the read file or bash tool. It also removes an erroneous @ prefix from the first path reference.

  • Removes the harness-internals explanation that was noise for non-agent readers, keeping the practical outcome identical.
  • Replaces the passive "read from disk" phrasing with an explicit tool-call instruction that is more actionable for agent consumers of CLAUDE.md.

Confidence Score: 5/5

Single-line prose edit to an agent instruction file with no runtime behaviour; safe to merge.

The change touches only one line of CLAUDE.md, removing a harness-implementation detail and making the instruction more direct. There is no logic, no code, and no schema involved — the only risk would be ambiguous wording, and the new phrasing is clearer than what it replaces.

No files require special attention.

Important Files Changed

Filename Overview
CLAUDE.md Rephrases the PR-body guidance: removes the @ prefix from the template path reference and replaces the HTML-comment-stripping explanation with a direct instruction to read the file using the read file or bash tool.

Reviews (1): Last reviewed commit: "docs(CLAUDE.md): tell agents to read PR ..." | 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 not alter performance

✅ 30 untouched benchmarks


Comparing litellm_pr_template_read_from_disk (46455e8) with litellm_internal_staging (ee69a62)

Open in CodSpeed

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.

1 participant