Skip to content

Commit

Permalink
Add documentation for focus_only_on_problems setting in improve.md an…
Browse files Browse the repository at this point in the history
…d README.md
  • Loading branch information
mrT23 committed Nov 7, 2024
1 parent d2663f9 commit a8c97bf
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions docs/docs/tools/improve.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>
</tr>
<tr>
<td><b>persistent_comment</b></td>
<td>If set to true, the improve comment will be persistent, meaning that every new improve request will edit the previous one. Default is false.</td>
Expand Down

0 comments on commit a8c97bf

Please sign in to comment.