mirror of
https://github.com/qodo-ai/pr-agent.git
synced 2025-07-05 21:30:40 +08:00
Add suggestion tracking feature with wiki documentation support
This commit is contained in:
@ -67,6 +67,31 @@ In post-process, Qodo Merge counts the number of suggestions that were implement
|
|||||||
|
|
||||||
{width=512}
|
{width=512}
|
||||||
|
|
||||||
|
## Suggestion tracking 💎
|
||||||
|
`Platforms supported: GitHub, GitLab`
|
||||||
|
|
||||||
|
Qodo Merge employs an innovative detection system to automatically [identify](https://qodo-merge-docs.qodo.ai/core-abilities/impact_evaluation/) code suggestions that PR authors have accepted and implemented.
|
||||||
|
|
||||||
|
Accepted suggestions are also automatically documented in a dedicated wiki page called `.pr_agent_accepted_suggestions`, allowing users to track historical changes, assess the tool's effectiveness, and learn from previously implemented recommendations in the repository.
|
||||||
|
An example [result](https://github.com/Codium-ai/pr-agent/wiki/.pr_agent_accepted_suggestions):
|
||||||
|
|
||||||
|
[{width=768}](https://github.com/Codium-ai/pr-agent/wiki/.pr_agent_accepted_suggestions)
|
||||||
|
|
||||||
|
This dedicated wiki page will also serve as a foundation for future AI model improvements, allowing it to learn from historically implemented suggestions and generate more targeted, contextually relevant recommendations.
|
||||||
|
|
||||||
|
This feature is controlled by a boolean configuration parameter: `pr_code_suggestions.wiki_page_accepted_suggestions` (default is true).
|
||||||
|
|
||||||
|
!!! note "Wiki must be enabled"
|
||||||
|
While the aggregation process is automatic, GitHub repositories require a one-time manual wiki setup.
|
||||||
|
|
||||||
|
To initialize the wiki: navigate to `Wiki`, select `Create the first page`, then click `Save page`.
|
||||||
|
|
||||||
|
{width=768}
|
||||||
|
|
||||||
|
Once a wiki repo is created, the tool will automatically use this wiki for tracking suggestions.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Usage Tips
|
## Usage Tips
|
||||||
|
|
||||||
@ -272,6 +297,10 @@ Using a combination of both can help the AI model to provide relevant and tailor
|
|||||||
<td><b>enable_chat_text</b></td>
|
<td><b>enable_chat_text</b></td>
|
||||||
<td>If set to true, the tool will display a reference to the PR chat in the comment. Default is true.</td>
|
<td>If set to true, the tool will display a reference to the PR chat in the comment. Default is true.</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><b>wiki_page_accepted_suggestions</b></td>
|
||||||
|
<td>If set to true, the tool will automatically track accepted suggestions in a dedicated wiki page called `.pr_agent_accepted_suggestions`. Default is true.</td>
|
||||||
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
??? example "Params for number of suggestions and AI calls"
|
??? example "Params for number of suggestions and AI calls"
|
||||||
|
@ -135,8 +135,9 @@ demand_code_suggestions_self_review=false # add a checkbox for the author to sel
|
|||||||
code_suggestions_self_review_text= "**Author self-review**: I have reviewed the PR code suggestions, and addressed the relevant ones."
|
code_suggestions_self_review_text= "**Author self-review**: I have reviewed the PR code suggestions, and addressed the relevant ones."
|
||||||
approve_pr_on_self_review=false # Pro feature. if true, the PR will be auto-approved after the author clicks on the self-review checkbox
|
approve_pr_on_self_review=false # Pro feature. if true, the PR will be auto-approved after the author clicks on the self-review checkbox
|
||||||
fold_suggestions_on_self_review=true # Pro feature. if true, the code suggestions will be folded after the author clicks on the self-review checkbox
|
fold_suggestions_on_self_review=true # Pro feature. if true, the code suggestions will be folded after the author clicks on the self-review checkbox
|
||||||
# Suggestion impact
|
# Suggestion impact 💎
|
||||||
publish_post_process_suggestion_impact=true
|
publish_post_process_suggestion_impact=true
|
||||||
|
wiki_page_accepted_suggestions=true
|
||||||
|
|
||||||
[pr_custom_prompt] # /custom_prompt #
|
[pr_custom_prompt] # /custom_prompt #
|
||||||
prompt = """\
|
prompt = """\
|
||||||
|
Reference in New Issue
Block a user