From a8c97bfa7398bcfe938aa7de5005f3f9981a21a5 Mon Sep 17 00:00:00 2001 From: mrT23 Date: Thu, 7 Nov 2024 08:30:18 +0200 Subject: [PATCH] Add documentation for focus_only_on_problems setting in improve.md and README.md --- README.md | 8 ++++++++ docs/docs/tools/improve.md | 4 ++++ 2 files changed, 12 insertions(+) diff --git a/README.md b/README.md index e96d31b5..9f04c539 100644 --- a/README.md +++ b/README.md @@ -43,6 +43,14 @@ Qode Merge PR-Agent aims to help efficiently review and handle pull requests, by ## News and Updates +### November 7, 2024 + +Added new option: `--pr_code_suggestions.focus_only_on_problems=true` + +When enabled, this option reduces the number of code suggestions and categorizes them into just two groups: "Possible Issues" and "General". The suggestions will focus primarily on identifying and fixing code problems, rather than style considerations like best practices, maintainability, or readability. + +This mode is ideal for developers who want to concentrate specifically on finding and fixing potential bugs in their pull request code. + ### November 4, 2024 Qodo Merge PR Agent will now leverage context from Jira or GitHub tickets to enhance the PR Feedback. Read more about this feature diff --git a/docs/docs/tools/improve.md b/docs/docs/tools/improve.md index fed8101c..524f49b8 100644 --- a/docs/docs/tools/improve.md +++ b/docs/docs/tools/improve.md @@ -275,6 +275,10 @@ Using a combination of both can help the AI model to provide relevant and tailor dual_publishing_score_threshold Minimum score threshold for suggestions to be presented as commitable PR comments in addition to the table. Default is -1 (disabled). + + focus_only_on_problems + 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. + persistent_comment If set to true, the improve comment will be persistent, meaning that every new improve request will edit the previous one. Default is false.