Tweak .PR.md format and prioritize charm-dev tools - #64
Merged
Conversation
Three changes to the prompt: 1. No hard-wrapping: instruct the agent to write each paragraph as a single long line. The markdown renderer handles wrapping. Hard-wrapped lines break rendering and make editing harder. 2. No Changes section: instruct the agent not to include a 'Changes' or 'Files changed' section. The reviewer can see the diff in GitHub. Focus on reasoning, not a file listing. 3. Prioritize charm-dev tools over standard tools: the claim is usually about how a charm-dev tool (Jubilant, ops, pytest-jubilant) behaves, not about how pytest or Python logging works in general. The agent should understand the charm-dev tool first (release notes, source, recent PRs) then dig into standard tools only if the mechanism still isn't clear. This would have helped the agent discover that Jubilant 1.12.0 moved verbose gron diffs to DEBUG and status changes to INFO (PR #351) — which is exactly what makes log_level=INFO meaningful.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Three changes to the prompt:
No hard-wrapping: instruct the agent to write each paragraph as a single long line. The markdown renderer handles wrapping. Hard-wrapped lines break rendering and make editing harder.
No Changes section: instruct the agent not to include a 'Changes' or 'Files changed' section. The reviewer can see the diff in GitHub. Focus on reasoning, not a file listing.
Prioritize charm-dev tools over standard tools: the claim is usually about how a charm-dev tool (Jubilant, ops, pytest-jubilant) behaves, not about how pytest or Python logging works in general. The agent should understand the charm-dev tool first (release notes, source, recent PRs) then dig into standard tools only if the mechanism still isn't clear.
This would have helped the agent discover that Jubilant 1.12.0 (PR #351) moved verbose gron diffs to DEBUG and status changes to INFO — which is exactly what makes
log_level=INFOmeaningful. The agent instead said "This is a claim about pytest's logging plugin behaviour, not Jubilant's" and missed the Jubilant version change entirely.