xiaxinhang/pr-agent
1
0
Fork 0
mirror of https://github.com/qodo-ai/pr-agent.git synced 2025-07-17 02:50:38 +08:00
Code Issues Packages Projects Releases Wiki Activity

Improve

Browse Source
This commit is contained in:
mrT23
2023-09-29 11:30:47 +03:00
parent 55f022d93e
commit c90e72cb75
5 changed files with 13 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -30,7 +30,8 @@ CodiumAI `PR-Agent` is an open-source tool aiming to help developers review pull
‣ **Find similar issue ([`/similar_issue`](./docs/SIMILAR_ISSUE.md))**: Automatically retrieves and presents similar issues ‣ **Find similar issue ([`/similar_issue`](./docs/SIMILAR_ISSUE.md))**: Automatically retrieves and presents similar issues
See the [usage guide](./Usage.md) for instructions how to run the different tools from [CLI](./Usage.md#working-from-a-local-repo-cli), or by [online usage](./Usage.md#online-usage), as well as additional details on optional commands and configurations. See the [Usage Guide](./Usage.md) for instructions how to run the different tools from CLI, online usage, Or by automatically triggering them when a new PR is opened.
See the [Tools Guide](./docs/TOOLS_GUIDE.md) for detailed description of the different tools.
[Release notes](./RELEASE_NOTES.md) [Release notes](./RELEASE_NOTES.md)

2
Usage.md
View File

@ -1,4 +1,4 @@
## Usage guide ## Usage Guide
### Table of Contents ### Table of Contents
- [Introduction](#introduction) - [Introduction](#introduction)

4
docs/DESCRIBE.md
View File

@ -7,9 +7,9 @@ It can ba invoked manually by commenting on any PR:
``` ```
For example: For example:
<img src=./../pics/describe_comment.png width="768"> <kbd><img src=./../pics/describe_comment.png width="768"></kbd>
<img src=./../pics/describe.png width="768"> <kbd><img src=./../pics/describe.png width="768"></kbd>
The `describe` tool can also be triggered automatically every time a new PR is opened. See examples for automatic triggers for [GitHub App](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) and [GitHub Action](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#working-with-github-action) The `describe` tool can also be triggered automatically every time a new PR is opened. See examples for automatic triggers for [GitHub App](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) and [GitHub Action](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#working-with-github-action)

6
docs/SIMILAR_ISSUE.md
View File

@ -6,9 +6,9 @@ It can ba invoked manually by commenting on any PR:
``` ```
For example: For example:
<img src=./../pics/similar_issue_original_issue.png width="768"> <kbd><img src=./../pics/similar_issue_original_issue.png width="768"></kbd>
<img src=./../pics/similar_issue_comment.png width="768"> <kbd><img src=./../pics/similar_issue_comment.png width="768"></kbd>
<img src=./../pics/similar_issue.png width="768"> <kbd><img src=./../pics/similar_issue.png width="768"></kbd>
Note that to perform retrieval, the `similar_issue` tool indexes all the repo previous issues (once). Note that to perform retrieval, the `similar_issue` tool indexes all the repo previous issues (once).

5
docs/TOOLS_GUIDE.md Normal file
View File

@ -0,0 +1,5 @@
## Table of Contents
- [DESCRIBE](./DESCRIBE.md)
- [REVIEW](./REVIEW.md)
- [IMPROVE](./IMPROVE.md)
- [SIMILAR_ISSUE](./SIMILAR_ISSUE.md)