mirror of
https://github.com/qodo-ai/pr-agent.git
synced 2025-07-03 04:10:49 +08:00
Merge branch 'main' into hl/refactor_install_md
# Conflicts: # README.md
This commit is contained in:
22
README.md
22
README.md
@ -16,30 +16,36 @@ CodiumAI `PR-Agent` is an open-source tool aiming to help developers review PRs
|
|||||||
|
|
||||||
**Auto-Description**: Automatically generating PR description - name, type, summary, and code walkthrough.
|
**Auto-Description**: Automatically generating PR description - name, type, summary, and code walkthrough.
|
||||||
\
|
\
|
||||||
**PR Review**: Feedback about the PR main theme, type, relevant tests, security issues, focused, and various suggestions for the PR content.
|
**PR Review**: Feedback about the PR main theme, type, relevant tests, security issues, focused PR, and various suggestions for the PR content.
|
||||||
\
|
\
|
||||||
**Question Answering**: Answering free-text questions about the PR.
|
**Question Answering**: Answering free-text questions about the PR.
|
||||||
\
|
\
|
||||||
**Code Suggestion**: Committable code suggestions for improving the PR.
|
**Code Suggestion**: Committable code suggestions for improving the PR.
|
||||||
|
|
||||||
Example results:
|
<h3>Example results:</h2>
|
||||||
</div>
|
</div>
|
||||||
<h>Describe:</h>
|
<h4>Describe:</h4>
|
||||||
<div align="center">
|
<div align="center">
|
||||||
<p float="center">
|
<p float="center">
|
||||||
<img src="./pics/describe.gif" width="800">
|
<img src="./pics/describe.gif" width="800">
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
<h>Ask:</h>
|
<h4>Review:</h4>
|
||||||
|
<div align="center">
|
||||||
|
<p float="center">
|
||||||
|
<img src="./pics/review.gif" width="800">
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
<h4>Ask:</h4>
|
||||||
<div align="center">
|
<div align="center">
|
||||||
<p float="center">
|
<p float="center">
|
||||||
<img src="./pics/ask.gif" width="800">
|
<img src="./pics/ask.gif" width="800">
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
<h>Code Suggestion:</h>
|
<h4>Improve:</h4>
|
||||||
<div align="center">
|
<div align="center">
|
||||||
<p float="center">
|
<p float="center">
|
||||||
<img src="./pics/pr_code_suggestions.png" width="800">
|
<img src="./pics/improve.gif" width="800">
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
<div align="left">
|
<div align="left">
|
||||||
@ -117,10 +123,10 @@ Here are several ways to install and run PR-Agent:
|
|||||||
|
|
||||||
**PR-Agent** provides four types of interactions ("tools"): `"PR Reviewer"`, `"PR Q&A"`, `"PR Description"` and `"PR Code Sueggestions"`.
|
**PR-Agent** provides four types of interactions ("tools"): `"PR Reviewer"`, `"PR Q&A"`, `"PR Description"` and `"PR Code Sueggestions"`.
|
||||||
|
|
||||||
- The "PR Reviewer" tool automatically analyzes PRs, and provides different types of feedbacks.
|
- The "PR Reviewer" tool automatically analyzes PRs, and provides different types of feedback.
|
||||||
- The "PR Ask" tool answers free-text questions about the PR.
|
- The "PR Ask" tool answers free-text questions about the PR.
|
||||||
- The "PR Description" tool automatically sets the PR Title and body.
|
- The "PR Description" tool automatically sets the PR Title and body.
|
||||||
- The "PR Code Suggestion" tool provide inline code suggestions for the PR, that can be applied and committed.
|
- The "PR Code Suggestion" tool provide inline code suggestions for the PR that can be applied and committed.
|
||||||
|
|
||||||
## How it works
|
## How it works
|
||||||
|
|
||||||
|
BIN
pics/improve.gif
Normal file
BIN
pics/improve.gif
Normal file
Binary file not shown.
After Width: | Height: | Size: 9.3 MiB |
BIN
pics/review.gif
Normal file
BIN
pics/review.gif
Normal file
Binary file not shown.
After Width: | Height: | Size: 20 MiB |
@ -94,7 +94,7 @@ async def polling_loop():
|
|||||||
success = await agent.handle_request(pr_url, rest_of_comment)
|
success = await agent.handle_request(pr_url, rest_of_comment)
|
||||||
if not success:
|
if not success:
|
||||||
git_provider.set_pr(pr_url)
|
git_provider.set_pr(pr_url)
|
||||||
git_provider.publish_comment("### How to user PR-Agent\n" +
|
git_provider.publish_comment("### How to use PR-Agent\n" +
|
||||||
bot_help_text(user_id))
|
bot_help_text(user_id))
|
||||||
|
|
||||||
elif response.status != 304:
|
elif response.status != 304:
|
||||||
|
Reference in New Issue
Block a user