docs: simplify wording and clarify exploration concept in best practices guide

This commit is contained in:
mrT23
2025-01-26 12:57:53 +02:00
parent f48c95d113
commit 63c98d30d9

View File

@ -8,13 +8,13 @@
Qodo Merge `improve` tool identifies potential issues, problems and bugs in Pull Request (PR) code changes. Qodo Merge `improve` tool identifies potential issues, problems and bugs in Pull Request (PR) code changes.
Rather than focusing on generic concepts like code style, the tool intelligently analyzes code to detect meaningful problems. Rather than focusing on generic concepts like code style, the tool intelligently analyzes code to detect meaningful problems.
The analysis is intentionally broad to allow discovery of diverse issues - from subtle bugs to architectural concerns. The analysis is intentionally broad to allow identifying a wide range of potential issues.
This open-ended exploration enables the tool to surface any relevant issues without being constrained to predefined categories. This open-ended _exploration_ enables the tool to surface any relevant issues without being constrained to predefined categories.
### Tracking Implemented Suggestions ### Tracking Implemented Suggestions
Qodo Merge features a novel [tracking system](https://qodo-merge-docs.qodo.ai/tools/improve/#suggestion-tracking) that automatically detects when PR authors implement AI-generated code suggestions. Qodo Merge features a novel [tracking system](https://qodo-merge-docs.qodo.ai/tools/improve/#suggestion-tracking) that automatically detects when PR authors implement AI-generated code suggestions.
All accepted suggestions are documented in a repository-specific wiki page called [`.pr_agent_accepted_suggestions`](https://github.com/qodo-ai/pr-agent/wiki/.pr_agent_accepted_suggestions). All accepted suggestions are aggregated in a repository-specific wiki page called [`.pr_agent_accepted_suggestions`](https://github.com/qodo-ai/pr-agent/wiki/.pr_agent_accepted_suggestions).
### Learning and Applying Auto Best Practices ### Learning and Applying Auto Best Practices