mirror of
https://github.com/qodo-ai/pr-agent.git
synced 2025-07-05 05:10:38 +08:00
readme
This commit is contained in:
@ -1,6 +1,8 @@
|
|||||||
## Overview
|
## Overview
|
||||||
The `help` tool provides a list of all the available tools and their descriptions.
|
The `help` tool provides a list of all the available tools and their descriptions.
|
||||||
For PR-Agent Pro users, it also enables to trigger each tool by checking the relevant box.
|
For PR-Agent Pro users, it also enables to trigger each tool by checking the relevant box.
|
||||||
|
|
||||||
|
It can be invoked manually by commenting on any PR:
|
||||||
```
|
```
|
||||||
/help
|
/help
|
||||||
```
|
```
|
||||||
@ -9,5 +11,7 @@ For PR-Agent Pro users, it also enables to trigger each tool by checking the rel
|
|||||||
An example [result](https://github.com/Codium-ai/pr-agent/pull/546#issuecomment-1868524805):
|
An example [result](https://github.com/Codium-ai/pr-agent/pull/546#issuecomment-1868524805):
|
||||||
|
|
||||||
{width=750}
|
{width=750}
|
||||||
|
|
||||||
→
|
→
|
||||||
|
|
||||||
{width=750}
|
{width=750}
|
||||||
|
@ -7,3 +7,11 @@ If you are subscribed to notifications for a repo with PR-Agent, we recommend tu
|
|||||||
As an alternative, you can filter in your mail provider the notifications specifically from the PR-Agent bot, [see how](https://www.quora.com/How-can-you-filter-emails-for-specific-people-in-Gmail#:~:text=On%20the%20Filters%20and%20Blocked,the%20body%20of%20the%20email).
|
As an alternative, you can filter in your mail provider the notifications specifically from the PR-Agent bot, [see how](https://www.quora.com/How-can-you-filter-emails-for-specific-people-in-Gmail#:~:text=On%20the%20Filters%20and%20Blocked,the%20body%20of%20the%20email).
|
||||||
|
|
||||||
{width=512}
|
{width=512}
|
||||||
|
|
||||||
|
|
||||||
|
Another option to reduce the mail overload is disable the help collapsible section in PR-Agent bot comments, by adding the relevant configurations to the `.pr_agent.toml` file.
|
||||||
|
For example, to disable the help text for the `pr_reviewer` tool, add to the configuration file:
|
||||||
|
```
|
||||||
|
[pr_reviewer]
|
||||||
|
enable_help_text = false
|
||||||
|
```
|
@ -25,6 +25,7 @@ nav:
|
|||||||
- Ask: 'tools/ask.md'
|
- Ask: 'tools/ask.md'
|
||||||
- Update Changelog: 'tools/update_changelog.md'
|
- Update Changelog: 'tools/update_changelog.md'
|
||||||
- Similar Issues: 'tools/similar_issues.md'
|
- Similar Issues: 'tools/similar_issues.md'
|
||||||
|
- Help: 'tools/help.md'
|
||||||
- 💎 Analyze: 'tools/analyze.md'
|
- 💎 Analyze: 'tools/analyze.md'
|
||||||
- 💎 Test: 'tools/test.md'
|
- 💎 Test: 'tools/test.md'
|
||||||
- 💎 Improve Component: 'tools/improve_component.md'
|
- 💎 Improve Component: 'tools/improve_component.md'
|
||||||
|
Reference in New Issue
Block a user