|
| 1 | +## Introduction |
| 2 | +The Git environment usually represents the final stage before code enters production. Hence, Detecting bugs and issues during the review process is critical. |
| 3 | + |
| 4 | +The [`improve`](https://qodo-merge-docs.qodo.ai/tools/improve/) tool provides actionable code suggestions for your pull requests, aiming to help detect and fix bugs and problems. |
| 5 | +By default, suggestions appear as a comment in a table format: |
| 6 | + |
| 7 | +{width=512} |
| 8 | + |
| 9 | +{width=512} |
| 10 | + |
| 11 | +## Validation of Code Suggestions |
| 12 | + |
| 13 | +Each suggestion in the table can be "applied", converting it to a committable Git code change that can be committed directly to the PR. |
| 14 | +This approach allows to fix issues without returning to your IDE for manual edits — significantly faster and more convenient. |
| 15 | + |
| 16 | +However, committing a suggestion in a Git environment carries more risk than in a local IDE, as you don't have the opportunity to fully run and test the code before committing. |
| 17 | + |
| 18 | +To balance convenience with safety, Qodo Merge implements a dual validation system for each generated code suggestion: |
| 19 | + |
| 20 | +1) **Localization** - Qodo Merge confirms that the suggestion's line numbers and surrounding code, as predicted by the model, actually match the repo code. This means that the model correctly identified the context and location of the code to be changed. |
| 21 | + |
| 22 | +2) **"Compilation"** - Using static code analysis, Qodo Merge verifies that after applying the suggestion, the file will still be valid, meaning tree-sitter syntax processing will not throw an error. This process is relevant for multiple programming languages, see [here](https://pypi.org/project/tree-sitter-languages/) for the full list of supported languages. |
| 23 | + |
| 24 | +When a suggestion fails to meet these validation criteria, it may still provide valuable feedback, but isn't suitable for direct application to the PR. |
| 25 | +In such cases, Qodo Merge will omit the 'apply' checkbox and instead display: |
| 26 | + |
| 27 | +`[To ensure code accuracy, apply this suggestion manually]` |
| 28 | + |
| 29 | +## Conclusion |
| 30 | + |
| 31 | +The validation methods described above enhance the reliability of code suggestions and help PR authors determine which suggestions are safer to apply in the Git environment. |
| 32 | +Of course, additional factors should be considered, such as suggestion complexity and potential code impact. |
| 33 | + |
| 34 | +Human judgment remains essential. After clicking 'apply', Qodo Merge still presents the 'before' and 'after' code snippets for review, allowing you to assess the changes before finalizing the commit. |
| 35 | + |
| 36 | +{width=512} |
0 commit comments