Tr/focus only on problems #79
Conversation
Signed-off-by: NxPKG <iconmamundentist@gmail.com>
Signed-off-by: NxPKG <iconmamundentist@gmail.com>
Signed-off-by: NxPKG <iconmamundentist@gmail.com>
Signed-off-by: NxPKG <iconmamundentist@gmail.com>
Reviewer's Guide by SourceryThis PR introduces a new feature to focus code suggestions primarily on critical problems and bugs rather than style and best practices. The implementation adds a new configuration option ER diagram for configuration changeserDiagram
CONFIGURATION {
bool focus_only_on_problems
int max_context_tokens
bool commitable_code_suggestions
int dual_publishing_score_threshold
}
CONFIGURATION ||--o{ PR_CODE_SUGGESTIONS : contains
CONFIGURATION {
bool focus_only_on_problems
}
note for CONFIGURATION "New configuration option added to focus on problems"
Class diagram for updated PR code suggestionsclassDiagram
class CodeSuggestion {
- existing_code: str
- improved_code: str
- one_sentence_summary: str
- label: str
}
class PRCodeSuggestions {
}
class PRCodeSuggestionsPrompt {
- system: str
}
class PRCodeSuggestionsHandler {
- focus_only_on_problems: bool
}
CodeSuggestion --> PRCodeSuggestions
PRCodeSuggestionsPrompt --> PRCodeSuggestionsHandler
PRCodeSuggestionsHandler : +focus_only_on_problems
note for PRCodeSuggestionsHandler "New attribute added to handle focus on problems"
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
|
Warning Rate limit exceeded@NxPKG has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 10 minutes and 57 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 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:
|
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:
- Could you explain why the max_context_tokens was increased from 14000 to 16000? Is this increase necessary for the new feature?
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: 1 issue found
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
| @@ -275,6 +275,10 @@ Using a combination of both can help the AI model to provide relevant and tailor | |||
| <td><b>dual_publishing_score_threshold</b></td> | |||
| <td>Minimum score threshold for suggestions to be presented as commitable PR comments in addition to the table. Default is -1 (disabled).</td> | |||
| </tr> | |||
| <tr> | |||
| <td><b>focus_only_on_problems</b></td> | |||
| <td>If set to true, suggestions will focus primarily on identifying and fixing code problems, and less on style considerations like best practices, maintainability, or readability. Default is false.</td> | |||
There was a problem hiding this comment.
nitpick (documentation): Consider adjusting punctuation to match other entries in the table
Other entries in the table end with a single period. Consider restructuring this entry to maintain consistent punctuation.
Signed-off-by: NxPKG <iconmamundentist@gmail.com>
User description
Notes for Reviewers
This PR fixes #
Signed commits
PR Type
enhancement, documentation
Description
focus_only_on_problemsto control whether code suggestions should focus primarily on identifying and fixing critical issues.pr_code_suggestions.pyto incorporate the new setting and adjust the logic for handling code suggestions.improve.mdto inform users about its purpose and usage.max_context_tokensinconfiguration.tomlto allow for more extensive context in suggestions.pr_code_suggestions_prompts.tomlto align with the new focus setting, ensuring suggestions are tailored to critical problems when enabled.Changes walkthrough 📝
pr_code_suggestions.py
Add focus-only-on-problems setting and adjust suggestion logicpr_insight/tools/pr_code_suggestions.py
focus_only_on_problemssetting to control suggestion focus.pr_code_suggestions_prompts.toml
Update prompts for focus_only_on_problems settingpr_insight/settings/pr_code_suggestions_prompts.toml
focus_only_on_problemssetting.improve.md
Document focus_only_on_problems setting in improve.mddocs/docs/tools/improve.md
focus_only_on_problemssetting.configuration.toml
Update configuration for focus_only_on_problems and context tokenspr_insight/settings/configuration.toml
max_context_tokensto 16000.focus_only_on_problemsconfiguration option.