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

similar issue

Browse Source
This commit is contained in:
mrT23
2023-09-29 10:01:32 +03:00
parent b8f93516ce
commit e1149862b2
8 changed files with 34 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/DESCRIBE.md
View File

@ -1,4 +1,4 @@
## Describe
# Describe Tool
The `describe` tool scans the PR code changes, and automatically generates PR description - title, type, summary, code walkthrough and labels.
It can ba invoked manually by commenting on any PR:
@ -15,7 +15,7 @@ The `describe` tool can also be triggered automatically every time a new PR is o
### Configuration options
Under the section 'pr_description', the [configuration file](pr_agent/settings/configuration.toml) contains options to customize the 'describe' tool:
Under the section 'pr_description', the [configuration file](./../pr_agent/settings/configuration.toml) contains options to customize the 'describe' tool:
- `publish_labels`: if set to true, the tool will publish the labels to the PR. Default is true.

29
docs/SIMILAR_ISSUE.md Normal file
View File

@ -0,0 +1,29 @@
# Similar Issue Tool
The similar issue tool retrieves the most similar issues to the current issue:
```
/similar issue
```
<img src=./../pics/similar_issue_original_issue.png width="768">
<img src=./../pics/similar_issue_comment.png width="768">
<img src=./../pics/similar_issue.png width="768">
Note that to perform retrieval, the `similar_issue` tool indexes all the repo previous issues (once).
To enable usage of the '**similar issue**' tool, you need to set the following keys in `.secrets.toml` (or in the relevant environment variables):
```
[pinecone]
api_key = "..."
environment = "..."
```
These parameters can be obtained by registering to [Pinecone](https://app.pinecone.io/?sessionType=signup/).
### How to use:
- To invoke the 'similar issue' tool from **CLI**, run:
`python3 cli.py --issue_url=... similar_issue`
- To invoke the 'similar' issue tool via online usage, [comment](https://github.com/Codium-ai/pr-agent/issues/178#issuecomment-1716934893) on a PR:
`/similar_issue`
- You can also enable the 'similar issue' tool to run automatically when a new issue is opened, by adding it to the [pr_commands list in the github_app section](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L66)