From 7fdbd6a68003aa87ce0e4cd7f30036d211400455 Mon Sep 17 00:00:00 2001 From: mrT23 Date: Wed, 19 Jul 2023 15:12:50 +0300 Subject: [PATCH 1/2] Update utils.py --- pr_agent/algo/utils.py | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/pr_agent/algo/utils.py b/pr_agent/algo/utils.py index ece59448..866b160e 100644 --- a/pr_agent/algo/utils.py +++ b/pr_agent/algo/utils.py @@ -30,8 +30,7 @@ def convert_to_markdown(output_data: dict) -> str: elif isinstance(value, list): if key.lower() == 'code suggestions': markdown_text += "\n" # just looks nicer with additional line breaks - # emoji = emojis.get(key, "‣") # Use a dash if no emoji is found for the key - emoji = "" + emoji = emojis.get(key, "") markdown_text += f"- {emoji} **{key}:**\n\n" for item in value: if isinstance(item, dict) and key.lower() == 'code suggestions': @@ -39,8 +38,7 @@ def convert_to_markdown(output_data: dict) -> str: elif item: markdown_text += f" - {item}\n" elif value != 'n/a': - # emoji = emojis.get(key, "‣") # Use a dash if no emoji is found for the key - emoji = "" + emoji = emojis.get(key, "") markdown_text += f"- {emoji} **{key}:** {value}\n" return markdown_text From 1f373d7b0a57a0c042c3be6803e3e62d9f08a77c Mon Sep 17 00:00:00 2001 From: Hussam Lawen Date: Wed, 19 Jul 2023 15:31:29 +0300 Subject: [PATCH 2/2] Update README.md --- README.md | 31 +++++++++++++++---------------- 1 file changed, 15 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 9165af8f..37e84ab7 100644 --- a/README.md +++ b/README.md @@ -50,9 +50,10 @@ CodiumAI `PR-Agent` is an open-source tool aiming to help developers review PRs
-- [Live demo](#live-demo) + - [Overview](#overview) -- [Quickstart](#quickstart) +- [Try it now](#try-it-now) +- [Installation](#installation) - [Usage and tools](#usage-and-tools) - [Configuration](./CONFIGURATION.md) - [How it works](#how-it-works) @@ -60,15 +61,7 @@ CodiumAI `PR-Agent` is an open-source tool aiming to help developers review PRs - [Similar projects](#similar-projects)
-## Live demo -Experience GPT-4 powered PR review on your public GitHub repository with our hosted PR-Agent. To try it, just mention `@CodiumAI-Agent` and add the desired command in any PR comment! The agent will generate a response based on your command. - -![Review generation process](https://codium.ai/images/demo.gif) - -To set up your own PR-Agent, see the [Quickstart](#Quickstart) section - ---- ## Overview `PR-Agent` offers extensive pull request functionalities across various git providers: | | | GitHub | Gitlab | Bitbucket | @@ -99,18 +92,24 @@ Examples for invoking the different tools via the [CLI](#quickstart): In the [configuration](./CONFIGURATION.md) file you can select your git provider (GitHub, Gitlab, Bitbucket), and further configure the different tools. -## Quickstart +## Try it now + +Try GPT-4 powered PR-Agent on your public GitHub repository for free. Just mention `@CodiumAI-Agent` and add the desired command in any PR comment! The agent will generate a response based on your command. + +![Review generation process](https://codium.ai/images/demo.gif) + +To set up your own PR-Agent, see the [Quickstart](#Quickstart) section + +--- + +## Installation To get started with PR-Agent quickly, you first need to acquire two tokens: 1. An OpenAI key from [here](https://platform.openai.com/), with access to GPT-4. 2. A GitHub personal access token (classic) with the repo scope. -There are several ways to use PR-Agent. Let's start with the simplest one: - - -## Install -Here are several ways to install and run PR-Agent: +There are several ways to use PR-Agent: - [Method 1: Use Docker image (no installation required)](INSTALL.md#method-1-use-docker-image-no-installation-required) - [Method 2: Run as a GitHub Action](INSTALL.md#method-2-run-as-a-github-action)