diff --git a/README.md b/README.md index aa961eac..1ed4db4a 100644 --- a/README.md +++ b/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. \ -**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. \ **Code Suggestion**: Committable code suggestions for improving the PR. -Example results: +

Example results:

-Describe: +

Describe:

-Ask: +

Review:

+
+

+ +

+
+

Ask:

-Code Suggestion: +

Improve:

- +

@@ -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"`. -- 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 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 diff --git a/pics/improve.gif b/pics/improve.gif new file mode 100644 index 00000000..97c94f67 Binary files /dev/null and b/pics/improve.gif differ diff --git a/pics/review.gif b/pics/review.gif new file mode 100644 index 00000000..2f9e7457 Binary files /dev/null and b/pics/review.gif differ diff --git a/pr_agent/servers/github_polling.py b/pr_agent/servers/github_polling.py index c46cf51b..4e567862 100644 --- a/pr_agent/servers/github_polling.py +++ b/pr_agent/servers/github_polling.py @@ -94,7 +94,7 @@ async def polling_loop(): success = await agent.handle_request(pr_url, rest_of_comment) if not success: 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)) elif response.status != 304: