Update pr_reviewer_prompts.toml #101
Conversation
Signed-off-by: NxPKG <iconmamundentist@gmail.com>
Reviewer's Guide by SourceryThis pull request updates the pr_reviewer_prompts.toml file to improve the clarity and accuracy of the prompts used for code reviews. Specifically, it corrects the example diff format and clarifies the usage of backticks. Flow diagram for updated PR reviewer prompt formattingflowchart LR
subgraph Before[Before Changes]
B1[Single quotes for code references]
B2[Verbose diff examples]
end
subgraph After[After Changes]
A1[Backticks for code references]
A2[Simplified diff examples]
end
B1 --> A1
B2 --> A2
style Before fill:#f0f0f0
style After fill:#e6f3ff
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
PR Reviewer Guide 🔍Here are some key observations to aid the review process:
|
|
Here's the code health analysis summary for commits Analysis Summary
|
PR Code Suggestions ✨Explore these optional code suggestions:
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @NxPKG - I've reviewed your changes - here's some feedback:
Overall Comments:
- Please update the PR description to include the issue number this fixes and check the signed commits box if you have signed your commits.
- Consider updating the PR title to follow the contributing convention by prepending the component name in square brackets, e.g. '[docs] Update pr_reviewer_prompts.toml'
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Signed-off-by: NxPKG <iconmamundentist@gmail.com>
Signed-off-by: NxPKG <iconmamundentist@gmail.com>
Signed-off-by: NxPKG <iconmamundentist@gmail.com>
User description
Notes for Reviewers
This PR fixes #
Signed commits
PR Type
Documentation
Description
Updated guidelines for quoting variables and file paths.
Adjusted example code lines for clarity and consistency.
Enhanced formatting instructions in the
pr_reviewer_prompts.tomlfile.Changes walkthrough 📝
pr_reviewer_prompts.toml
Documentation and formatting improvements in prompts filepr_insight/settings/pr_reviewer_prompts.toml