From 82b58d5b09068e0267100bed87b301681d53a06e Mon Sep 17 00:00:00 2001 From: Tal Date: Fri, 5 Jan 2024 21:37:45 +0200 Subject: [PATCH 1/3] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 4f8507c2..5fe3dd93 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,7 @@ See the [Tools Guide](./docs/TOOLS_GUIDE.md) for detailed description of the dif - [Features overview](#features-overview) - [Try it now](#try-it-now) - [Installation](#installation) -- [PR-Agent Pro 💎](#pr-agent-pro) +- [PR-Agent Pro 💎](#pr-agent-pro-) - [How it works](#how-it-works) - [Why use PR-Agent?](#why-use-pr-agent) @@ -125,7 +125,7 @@ See the [Tools Guide](./docs/TOOLS_GUIDE.md) for detailed description of the dif -## Features Overview +## Features overview `PR-Agent` offers extensive pull request functionalities across various git providers: | | | GitHub | Gitlab | Bitbucket | |-------|---------------------------------------------|:------:|:------:|:---------:| @@ -232,7 +232,7 @@ Here are some advantages of PR-Agent: - We support **multiple git providers** (GitHub, Gitlab, Bitbucket), **multiple ways** to use the tool (CLI, GitHub Action, GitHub App, Docker, ...), and **multiple models** (GPT-4, GPT-3.5, Anthropic, Cohere, Llama2). -## Data Privacy +## Data privacy If you host PR-Agent with your OpenAI API key, it is between you and OpenAI. You can read their API data privacy policy here: https://openai.com/enterprise-privacy From c9717f1d732a1fc38a04ae3005e9d9b1dfb1c007 Mon Sep 17 00:00:00 2001 From: Tal Date: Fri, 5 Jan 2024 23:29:59 +0200 Subject: [PATCH 2/3] Update README.md --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 5fe3dd93..341ae5d6 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,7 @@ See the [Installation Guide](./INSTALL.md) for instructions on installing and ru See the [Usage Guide](./Usage.md) for running the PR-Agent commands via different interfaces, including _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 (tools are run via the commands). +See the [Tools Guide](./docs/TOOLS_GUIDE.md) for a detailed description of the different tools (tools are run via the commands). ## Table of Contents - [Example results](#example-results) @@ -65,7 +65,7 @@ See the [Tools Guide](./docs/TOOLS_GUIDE.md) for detailed description of the dif

- +

/improve

@@ -76,7 +76,7 @@ See the [Tools Guide](./docs/TOOLS_GUIDE.md) for detailed description of the dif

- +

/generate_labels

@@ -123,7 +123,7 @@ See the [Tools Guide](./docs/TOOLS_GUIDE.md) for detailed description of the dif

- +
## Features overview `PR-Agent` offers extensive pull request functionalities across various git providers: @@ -202,7 +202,7 @@ There are several ways to use PR-Agent: 1. **Self-hosting** - We take care of everything for you - hosting, models, regular updates, and more. Installation is as simple as signing up and adding the PR-Agent app to your GitHub\BitBucket repo. 2. **Improved privacy** - No data will be stored or used to train models. PR-Agent Pro will employ zero data retention, and will use an OpenAI account with zero data retention. 3. **Improved support** - PR-Agent Pro users will receive priority support, and will be able to request new features and capabilities. -4. **Extra features** -In addition to the benefits listed above, PR-Agent Pro will emphasize more customization, and the usage of static code analysis, in addition to LLM logic, to improve results. It has the following additional feature: +4. **Extra features** -In addition to the benefits listed above, PR-Agent Pro will emphasize more customization, and the usage of static code analysis, in addition to LLM logic, to improve results. It has the following additional features: - [**SOC2 compliance check**](https://github.com/Codium-ai/pr-agent/blob/main/docs/REVIEW.md#soc2-ticket-compliance-) - [**PR documentation**](https://github.com/Codium-ai/pr-agent/blob/main/docs/ADD_DOCUMENTATION.md) - [**Custom labels**](https://github.com/Codium-ai/pr-agent/blob/main/docs/DESCRIBE.md#handle-custom-labels-from-the-repos-labels-page-gem) @@ -222,7 +222,7 @@ Check out the [PR Compression strategy](./PR_COMPRESSION.md) page for more detai ## Why use PR-Agent? -A reasonable question that can be asked is: `"Why use PR-Agent? What make it stand out from existing tools?"` +A reasonable question that can be asked is: `"Why use PR-Agent? What makes it stand out from existing tools?"` Here are some advantages of PR-Agent: @@ -237,7 +237,7 @@ Here are some advantages of PR-Agent: If you host PR-Agent with your OpenAI API key, it is between you and OpenAI. You can read their API data privacy policy here: https://openai.com/enterprise-privacy -When using PR-Agent Pro 💎, hosted by CodiumAI, we will not store any of your data, nor will we used it for training. +When using PR-Agent Pro 💎, hosted by CodiumAI, we will not store any of your data, nor will we use it for training. You will also benefit from an OpenAI account with zero data retention. ## Links From 6d359fe1d8c5d76d9128533401a5ee61b4120126 Mon Sep 17 00:00:00 2001 From: Tal Date: Sat, 6 Jan 2024 21:46:11 +0200 Subject: [PATCH 3/3] Update DESCRIBE.md --- docs/DESCRIBE.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/DESCRIBE.md b/docs/DESCRIBE.md index 302874ae..d5fd6988 100644 --- a/docs/DESCRIBE.md +++ b/docs/DESCRIBE.md @@ -100,20 +100,20 @@ The marker `pr_agent:type` will be replaced with the PR type, `pr_agent:summary` ### Automation - When you first install the app, the [default mode](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) for the describe tool is: ``` -pr_commands = ["describe --pr_description.add_original_user_description=true - --pr_description.keep_original_user_title=true", ...] +pr_commands = ["/describe --pr_description.add_original_user_description=true" + "--pr_description.keep_original_user_title=true", ...] ``` meaning the `describe` tool will run automatically on every PR, will keep the original title, and will add the original user description above the generated description.
This default is quite conservative, and strikes a good balance between automation and control: If you want more automation, just give the PR a title, and the tool will auto-write a full description; If you want more control, you can add a detailed description, and the tool will add the complementary description below it. - For maximal automation, you can change the default mode to: ``` -pr_commands = ["describe --pr_description.add_original_user_description=false - --pr_description.keep_original_user_title=true", ...] +pr_commands = ["/describe --pr_description.add_original_user_description=false" + "--pr_description.keep_original_user_title=true", ...] ``` so the title will be auto-generated as well. - Markers are an alternative way to control the generated description, to give maximal control to the user. If you set: ``` -pr_commands = ["describe --pr_description.use_description_markers=true", ...] +pr_commands = ["/describe --pr_description.use_description_markers=true", ...] ``` the tool will replace every marker of the form `pr_agent:marker_name` in the PR description with the relevant content, where `marker_name` is one of the following: - `type`: the PR type. @@ -135,4 +135,4 @@ Examples for custom labels: The list above is eclectic, and aims to give an idea of different possibilities. Define the custom labels that are relevant for your repo and use cases. Note that Labels are not mutually exclusive, so you can add multiple label categories. -Make sure to provide proper title, and detailed and well-phrased description for each label, so the tool will know when to suggest it. \ No newline at end of file +Make sure to provide proper title, and detailed and well-phrased description for each label, so the tool will know when to suggest it.