docs(CLAUDE.md): tell agents to read the PR template file themselves - #32383
docs(CLAUDE.md): tell agents to read the PR template file themselves#32383devin-ai-integration[bot] wants to merge 1 commit into
Conversation
…p HTML wording Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Greptile SummaryThis PR tightens the PR-body authoring guidance in
Confidence Score: 5/5Single-line prose edit to an agent instruction file with no runtime behaviour; safe to merge. The change touches only one line of No files require special attention.
|
| 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 Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Relevant issues
Follow-up to #32373
Linear ticket
Pre-Submission checklist
@greptileaito 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