From 7be26b665e22e054722578e609b2cb9b681c5cbb Mon Sep 17 00:00:00 2001 From: ofir-frd Date: Wed, 22 Jan 2025 10:12:32 +0200 Subject: [PATCH 1/6] docs: update branding from PR-Agent to Qodo-Merge in README --- README.md | 124 +++++++++++++++++++++++++++--------------------------- 1 file changed, 62 insertions(+), 62 deletions(-) diff --git a/README.md b/README.md index 0f9dd911..d74c646f 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ Qode Merge PR-Agent aims to help efficiently review and handle pull requests, by providing AI feedback and suggestions -[![Static Badge](https://img.shields.io/badge/Chrome-Extension-violet)](https://chromewebstore.google.com/detail/pr-agent-chrome-extension/ephlnjeghhogofkifjloamocljapahnl) +[![Static Badge](https://img.shields.io/badge/Chrome-Extension-violet)](https://chromewebstore.google.com/detail/qodo-merge-ai-powered-cod/ephlnjeghhogofkifjloamocljapahnl) [![Static Badge](https://img.shields.io/badge/Pro-App-blue)](https://github.com/apps/qodo-merge-pro/) [![Static Badge](https://img.shields.io/badge/OpenSource-App-red)](https://github.com/apps/qodo-merge-pro-for-open-source/) [![Discord](https://badgen.net/badge/icon/discord?icon=discord&label&color=purple)](https://discord.com/channels/1057273017547378788/1126104260430528613) @@ -22,7 +22,7 @@ Qode Merge PR-Agent aims to help efficiently review and handle pull requests, by -### [Documentation](https://pr-agent-docs.codium.ai/) +### [Documentation](https://qodo-merge-docs.qodo.ai/) - See the [Installation Guide](https://qodo-merge-docs.qodo.ai/installation/) for instructions on installing Qode Merge PR-Agent on different platforms. - See the [Usage Guide](https://qodo-merge-docs.qodo.ai/usage-guide/) for instructions on running Qode Merge PR-Agent tools via different interfaces, such as CLI, PR Comments, or by automatically triggering them when a new PR is opened. @@ -35,9 +35,9 @@ Qode Merge PR-Agent aims to help efficiently review and handle pull requests, by - [Overview](#overview) - [Example results](#example-results) - [Try it now](#try-it-now) -- [PR-Agent Pro ๐Ÿ’Ž](https://pr-agent-docs.codium.ai/overview/pr_agent_pro/) +- [Qodo-Merge Pro ๐Ÿ’Ž](https://qodo-merge-docs.qodo.ai/overview/pr_agent_pro/) - [How it works](#how-it-works) -- [Why use PR-Agent?](#why-use-pr-agent) +- [Why use Qodo-Merge?](#why-use-qodo-merge) ## News and Updates @@ -45,7 +45,7 @@ Qode Merge PR-Agent aims to help efficiently review and handle pull requests, by New tool [/Implement](https://qodo-merge-docs.qodo.ai/tools/implement/) (๐Ÿ’Ž), which converts human code review discussions and feedback into ready-to-commit code changes. - + ### Jan 1, 2025 @@ -54,7 +54,7 @@ Update logic and [documentation](https://qodo-merge-docs.qodo.ai/usage-guide/cha ### December 30, 2024 -Following [feedback](https://research.kudelskisecurity.com/2024/08/29/careful-where-you-code-multiple-vulnerabilities-in-ai-powered-pr-agent/) from the community, we have addressed two vulnerabilities identified in the open-source PR-Agent project. The fixes are now included in the newly released version (v0.26), available as of today. +Following [feedback](https://research.kudelskisecurity.com/2024/08/29/careful-where-you-code-multiple-vulnerabilities-in-ai-powered-pr-agent/) from the community, we have addressed two vulnerabilities identified in the open-source Qodo-Merge project. The fixes are now included in the newly released version (v0.26), available as of today. ### December 25, 2024 @@ -101,20 +101,20 @@ Supported commands per platform: | | [Describe](https://qodo-merge-docs.qodo.ai/tools/describe/) | โœ… | โœ… | โœ… | โœ… | | | [Improve](https://qodo-merge-docs.qodo.ai/tools/improve/) | โœ… | โœ… | โœ… | โœ… | | | [Ask](https://qodo-merge-docs.qodo.ai/tools/ask/) | โœ… | โœ… | โœ… | โœ… | -| | โฎ‘ [Ask on code lines](https://pr-agent-docs.codium.ai/tools/ask#ask-lines) | โœ… | โœ… | | | +| | โฎ‘ [Ask on code lines](https://qodo-merge-docs.qodo.ai/tools/ask/#ask-lines) | โœ… | โœ… | | | | | [Update CHANGELOG](https://qodo-merge-docs.qodo.ai/tools/update_changelog/) | โœ… | โœ… | โœ… | โœ… | | | [Ticket Context](https://qodo-merge-docs.qodo.ai/core-abilities/fetching_ticket_context/) ๐Ÿ’Ž | โœ… | โœ… | โœ… | | | | [Utilizing Best Practices](https://qodo-merge-docs.qodo.ai/tools/improve/#best-practices) ๐Ÿ’Ž | โœ… | โœ… | โœ… | | | | [PR Chat](https://qodo-merge-docs.qodo.ai/chrome-extension/features/#pr-chat) ๐Ÿ’Ž | โœ… | | | | | | [Suggestion Tracking](https://qodo-merge-docs.qodo.ai/tools/improve/#suggestion-tracking) ๐Ÿ’Ž | โœ… | โœ… | | | -| | [CI Feedback](https://pr-agent-docs.codium.ai/tools/ci_feedback/) ๐Ÿ’Ž | โœ… | | | | -| | [PR Documentation](https://pr-agent-docs.codium.ai/tools/documentation/) ๐Ÿ’Ž | โœ… | โœ… | | | -| | [Custom Labels](https://pr-agent-docs.codium.ai/tools/custom_labels/) ๐Ÿ’Ž | โœ… | โœ… | | | -| | [Analyze](https://pr-agent-docs.codium.ai/tools/analyze/) ๐Ÿ’Ž | โœ… | โœ… | | | -| | [Similar Code](https://pr-agent-docs.codium.ai/tools/similar_code/) ๐Ÿ’Ž | โœ… | | | | -| | [Custom Prompt](https://pr-agent-docs.codium.ai/tools/custom_prompt/) ๐Ÿ’Ž | โœ… | โœ… | โœ… | | -| | [Test](https://pr-agent-docs.codium.ai/tools/test/) ๐Ÿ’Ž | โœ… | โœ… | | | -| | [Implement](https://pr-agent-docs.codium.ai/tools/implement/) ๐Ÿ’Ž | โœ… | โœ… | โœ… | | +| | [CI Feedback](https://qodo-merge-docs.qodo.ai/tools/ci_feedback/) ๐Ÿ’Ž | โœ… | | | | +| | [PR Documentation](https://qodo-merge-docs.qodo.ai/tools/documentation/) ๐Ÿ’Ž | โœ… | โœ… | | | +| | [Custom Labels](https://qodo-merge-docs.qodo.ai/tools/custom_labels/) ๐Ÿ’Ž | โœ… | โœ… | | | +| | [Analyze](https://qodo-merge-docs.qodo.ai/tools/analyze/) ๐Ÿ’Ž | โœ… | โœ… | | | +| | [Similar Code](https://qodo-merge-docs.qodo.ai/tools/similar_code/) ๐Ÿ’Ž | โœ… | | | | +| | [Custom Prompt](https://qodo-merge-docs.qodo.ai/tools/custom_prompt/) ๐Ÿ’Ž | โœ… | โœ… | โœ… | | +| | [Test](https://qodo-merge-docs.qodo.ai/tools/test/) ๐Ÿ’Ž | โœ… | โœ… | | | +| | [Implement](https://qodo-merge-docs.qodo.ai/tools/implement/) ๐Ÿ’Ž | โœ… | โœ… | โœ… | | | | | | | | | | USAGE | [CLI](https://qodo-merge-docs.qodo.ai/usage-guide/automations_and_usage/#local-repo-cli) | โœ… | โœ… | โœ… | โœ… | | | [App / webhook](https://qodo-merge-docs.qodo.ai/usage-guide/automations_and_usage/#github-app) | โœ… | โœ… | โœ… | โœ… | @@ -124,45 +124,45 @@ Supported commands per platform: | CORE | [PR compression](https://qodo-merge-docs.qodo.ai/core-abilities/compression_strategy/) | โœ… | โœ… | โœ… | โœ… | | | Adaptive and token-aware file patch fitting | โœ… | โœ… | โœ… | โœ… | | | [Multiple models support](https://qodo-merge-docs.qodo.ai/usage-guide/changing_a_model/) | โœ… | โœ… | โœ… | โœ… | -| | [Local and global metadata](https://qodo-merge-docs.qodo.ai/core-abilities/metadata/) | โœ… | โœ… | โœ… | โœ… | +| 3 | [Local and global metadata](https://qodo-merge-docs.qodo.ai/core-abilities/metadata/) | โœ… | โœ… | โœ… | โœ… | | | [Dynamic context](https://qodo-merge-docs.qodo.ai/core-abilities/dynamic_context/) | โœ… | โœ… | โœ… | โœ… | | | [Self reflection](https://qodo-merge-docs.qodo.ai/core-abilities/self_reflection/) | โœ… | โœ… | โœ… | โœ… | | | [Static code analysis](https://qodo-merge-docs.qodo.ai/core-abilities/static_code_analysis/) ๐Ÿ’Ž | โœ… | โœ… | โœ… | | -| | [Global and wiki configurations](https://pr-agent-docs.codium.ai/usage-guide/configuration_options/) ๐Ÿ’Ž | โœ… | โœ… | โœ… | | -| | [PR interactive actions](https://www.codium.ai/images/pr_agent/pr-actions.mp4) ๐Ÿ’Ž | โœ… | โœ… | | | +| | [Global and wiki configurations](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/) ๐Ÿ’Ž | โœ… | โœ… | โœ… | | +| | [PR interactive actions](https://www.qodo.ai/images/pr_agent/pr-actions.mp4) ๐Ÿ’Ž | โœ… | โœ… | | | | | [Impact Evaluation](https://qodo-merge-docs.qodo.ai/core-abilities/impact_evaluation/) ๐Ÿ’Ž | โœ… | โœ… | | | -- ๐Ÿ’Ž means this feature is available only in [PR-Agent Pro](https://www.codium.ai/pricing/) +- ๐Ÿ’Ž means this feature is available only in [Qodo-Merge Pro](https://www.qodo.ai/pricing/) [//]: # (- Support for additional git providers is described in [here](./docs/Full_environments.md)) ___ -โ€ฃ **Auto Description ([`/describe`](https://pr-agent-docs.codium.ai/tools/describe/))**: Automatically generating PR description - title, type, summary, code walkthrough and labels. +โ€ฃ **Auto Description ([`/describe`](https://qodo-merge-docs.qodo.ai/tools/describe/))**: Automatically generating PR description - title, type, summary, code walkthrough and labels. \ -โ€ฃ **Auto Review ([`/review`](https://pr-agent-docs.codium.ai/tools/review/))**: Adjustable feedback about the PR, possible issues, security concerns, review effort and more. +โ€ฃ **Auto Review ([`/review`](https://qodo-merge-docs.qodo.ai/tools/review/))**: Adjustable feedback about the PR, possible issues, security concerns, review effort and more. \ -โ€ฃ **Code Suggestions ([`/improve`](https://pr-agent-docs.codium.ai/tools/improve/))**: Code suggestions for improving the PR. +โ€ฃ **Code Suggestions ([`/improve`](https://qodo-merge-docs.qodo.ai/tools/improve/))**: Code suggestions for improving the PR. \ -โ€ฃ **Question Answering ([`/ask ...`](https://pr-agent-docs.codium.ai/tools/ask/))**: Answering free-text questions about the PR. +โ€ฃ **Question Answering ([`/ask ...`](https://qodo-merge-docs.qodo.ai/tools/ask/))**: Answering free-text questions about the PR. \ -โ€ฃ **Update Changelog ([`/update_changelog`](https://pr-agent-docs.codium.ai/tools/update_changelog/))**: Automatically updating the CHANGELOG.md file with the PR changes. +โ€ฃ **Update Changelog ([`/update_changelog`](https://qodo-merge-docs.qodo.ai/tools/update_changelog/))**: Automatically updating the CHANGELOG.md file with the PR changes. \ -โ€ฃ **Find Similar Issue ([`/similar_issue`](https://pr-agent-docs.codium.ai/tools/similar_issues/))**: Automatically retrieves and presents similar issues. +โ€ฃ **Find Similar Issue ([`/similar_issue`](https://qodo-merge-docs.qodo.ai/tools/similar_issues/))**: Automatically retrieves and presents similar issues. \ -โ€ฃ **Add Documentation ๐Ÿ’Ž ([`/add_docs`](https://pr-agent-docs.codium.ai/tools/documentation/))**: Generates documentation to methods/functions/classes that changed in the PR. +โ€ฃ **Add Documentation ๐Ÿ’Ž ([`/add_docs`](https://qodo-merge-docs.qodo.ai/tools/documentation/))**: Generates documentation to methods/functions/classes that changed in the PR. \ -โ€ฃ **Generate Custom Labels ๐Ÿ’Ž ([`/generate_labels`](https://pr-agent-docs.codium.ai/tools/custom_labels/))**: Generates custom labels for the PR, based on specific guidelines defined by the user. +โ€ฃ **Generate Custom Labels ๐Ÿ’Ž ([`/generate_labels`](https://qodo-merge-docs.qodo.ai/tools/custom_labels/))**: Generates custom labels for the PR, based on specific guidelines defined by the user. \ -โ€ฃ **Analyze ๐Ÿ’Ž ([`/analyze`](https://pr-agent-docs.codium.ai/tools/analyze/))**: Identify code components that changed in the PR, and enables to interactively generate tests, docs, and code suggestions for each component. +โ€ฃ **Analyze ๐Ÿ’Ž ([`/analyze`](https://qodo-merge-docs.qodo.ai/tools/analyze/))**: Identify code components that changed in the PR, and enables to interactively generate tests, docs, and code suggestions for each component. \ -โ€ฃ **Test ๐Ÿ’Ž ([`/test`](https://pr-agent-docs.codium.ai/tools/test/))**: Generate tests for a selected component, based on the PR code changes. +โ€ฃ **Test ๐Ÿ’Ž ([`/test`](https://qodo-merge-docs.qodo.ai/tools/test/))**: Generate tests for a selected component, based on the PR code changes. \ -โ€ฃ **Custom Prompt ๐Ÿ’Ž ([`/custom_prompt`](https://pr-agent-docs.codium.ai/tools/custom_prompt/))**: Automatically generates custom suggestions for improving the PR code, based on specific guidelines defined by the user. +โ€ฃ **Custom Prompt ๐Ÿ’Ž ([`/custom_prompt`](https://qodo-merge-docs.qodo.ai/tools/custom_prompt/))**: Automatically generates custom suggestions for improving the PR code, based on specific guidelines defined by the user. \ -โ€ฃ **Generate Tests ๐Ÿ’Ž ([`/test component_name`](https://pr-agent-docs.codium.ai/tools/test/))**: Generates unit tests for a selected component, based on the PR code changes. +โ€ฃ **Generate Tests ๐Ÿ’Ž ([`/test component_name`](https://qodo-merge-docs.qodo.ai/tools/test/))**: Generates unit tests for a selected component, based on the PR code changes. \ -โ€ฃ **CI Feedback ๐Ÿ’Ž ([`/checks ci_job`](https://pr-agent-docs.codium.ai/tools/ci_feedback/))**: Automatically generates feedback and analysis for a failed CI job. +โ€ฃ **CI Feedback ๐Ÿ’Ž ([`/checks ci_job`](https://qodo-merge-docs.qodo.ai/tools/ci_feedback/))**: Automatically generates feedback and analysis for a failed CI job. \ -โ€ฃ **Similar Code ๐Ÿ’Ž ([`/find_similar_component`](https://pr-agent-docs.codium.ai/tools/similar_code/))**: Retrieves the most similar code components from inside the organization's codebase, or from open-source code. +โ€ฃ **Similar Code ๐Ÿ’Ž ([`/find_similar_component`](https://qodo-merge-docs.qodo.ai/tools/similar_code/))**: Retrieves the most similar code components from inside the organization's codebase, or from open-source code. \ โ€ฃ **Implement ๐Ÿ’Ž ([`/implement`](https://qodo-merge-docs.qodo.ai/tools/implement/))**: Generates implementation code from review suggestions. ___ @@ -206,7 +206,7 @@ ___ ## Try it now -Try the GPT-4 powered PR-Agent instantly on _your public GitHub repository_. Just mention `@CodiumAI-Agent` and add the desired command in any PR comment. The agent will generate a response based on your command. +Try the GPT-4 powered Qodo-Merge PR-Agent instantly on _your public GitHub repository_. Just mention `@CodiumAI-Agent` and add the desired command in any PR comment. The agent will generate a response based on your command. For example, add a comment to any pull request with the following text: ``` @CodiumAI-Agent /review @@ -220,67 +220,67 @@ It does not have 'edit' access to your repo, for example, so it cannot update th ![Review generation process](https://www.codium.ai/images/demo-2.gif) -To set up your own PR-Agent, see the [Installation](https://pr-agent-docs.codium.ai/installation/) section below. -Note that when you set your own PR-Agent or use CodiumAI hosted PR-Agent, there is no need to mention `@CodiumAI-Agent ...`. Instead, directly start with the command, e.g., `/ask ...`. +To set up your own Qodo-Merge PR-Agent, see the [Installation](https://qodo-merge-docs.qodo.ai/installation/) section below. +Note that when you set your own Qodo-Merge PR-Agent or use Qodo hosted Qodo-Merge PR-Agent, there is no need to mention `@CodiumAI-Agent ...`. Instead, directly start with the command, e.g., `/ask ...`. --- -## PR-Agent Pro ๐Ÿ’Ž -[PR-Agent Pro](https://www.codium.ai/pricing/) is a hosted version of PR-Agent, provided by CodiumAI. It is available for a monthly fee, and provides the following benefits: -1. **Fully managed** - 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\GitLab\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. -See [here](https://qodo-merge-docs.qodo.ai/overview/pr_agent_pro/) for a list of features available in PR-Agent Pro. +## Qodo-Merge Pro ๐Ÿ’Ž +[Qodo-Merge Pro](https://www.qodo.ai/pricing/) is a hosted version of Qodo-Merge, provided by Qodo. It is available for a monthly fee, and provides the following benefits: +1. **Fully managed** - We take care of everything for you - hosting, models, regular updates, and more. Installation is as simple as signing up and adding the Qodo-Merge app to your GitHub\GitLab\BitBucket repo. +2. **Improved privacy** - No data will be stored or used to train models. Qodo-Merge Pro will employ zero data retention, and will use an OpenAI account with zero data retention. +3. **Improved support** - Qodo-Merge 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, Qodo-Merge Pro will emphasize more customization, and the usage of static code analysis, in addition to LLM logic, to improve results. +See [here](https://qodo-merge-docs.qodo.ai/overview/pr_agent_pro/) for a list of features available in Qodo-Merge Pro. ## How it works -The following diagram illustrates PR-Agent tools and their flow: +The following diagram illustrates Qodo-Merge tools and their flow: -![PR-Agent Tools](https://codium.ai/images/pr_agent/diagram-v0.9.png) +![Qodo-Merge Tools](https://www.qodo.ai/images/pr_agent/diagram-v0.9.png) -Check out the [PR Compression strategy](https://pr-agent-docs.codium.ai/core-abilities/#pr-compression-strategy) page for more details on how we convert a code diff to a manageable LLM prompt +Check out the [PR Compression strategy](https://qodo-merge-docs.qodo.ai/core-abilities/#pr-compression-strategy) page for more details on how we convert a code diff to a manageable LLM prompt -## Why use PR-Agent? +## Why use Qodo-Merge? -A reasonable question that can be asked is: `"Why use PR-Agent? What makes it stand out from existing tools?"` +A reasonable question that can be asked is: `"Why use Qodo-Merge? What makes it stand out from existing tools?"` -Here are some advantages of PR-Agent: +Here are some advantages of Qodo-Merge: - We emphasize **real-life practical usage**. Each tool (review, improve, ask, ...) has a single GPT-4 call, no more. We feel that this is critical for realistic team usage - obtaining an answer quickly (~30 seconds) and affordably. -- Our [PR Compression strategy](https://pr-agent-docs.codium.ai/core-abilities/#pr-compression-strategy) is a core ability that enables to effectively tackle both short and long PRs. +- Our [PR Compression strategy](https://qodo-merge-docs.qodo.ai/core-abilities/#pr-compression-strategy) is a core ability that enables to effectively tackle both short and long PRs. - Our JSON prompting strategy enables to have **modular, customizable tools**. For example, the '/review' tool categories can be controlled via the [configuration](pr_agent/settings/configuration.toml) file. Adding additional categories is easy and accessible. - 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 -### Self-hosted PR-Agent +### Self-hosted Qodo-Merge -- 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: +- If you host Qodo-Merge 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 -### CodiumAI-hosted PR-Agent Pro ๐Ÿ’Ž +### Qodo-hosted Qodo-Merge Pro ๐Ÿ’Ž -- 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. +- When using Qodo-Merge Pro ๐Ÿ’Ž, hosted by Qodo, 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. -- For certain clients, CodiumAI-hosted PR-Agent Pro will use CodiumAIโ€™s proprietary models โ€” if this is the case, you will be notified. +- For certain clients, Qodo-hosted Qodo-Merge Pro will use Qodoโ€™s proprietary models โ€” if this is the case, you will be notified. -- No passive collection of Code and Pull Requestsโ€™ data โ€” PR-Agent will be active only when you invoke it, and it will then extract and analyze only data relevant to the executed command and queried pull request. +- No passive collection of Code and Pull Requestsโ€™ data โ€” Qodo-Merge will be active only when you invoke it, and it will then extract and analyze only data relevant to the executed command and queried pull request. -### PR-Agent Chrome extension +### Qodo-Merge Chrome extension -- The [PR-Agent Chrome extension](https://chromewebstore.google.com/detail/pr-agent-chrome-extension/ephlnjeghhogofkifjloamocljapahnl) serves solely to modify the visual appearance of a GitHub PR screen. It does not transmit any user's repo or pull request code. Code is only sent for processing when a user submits a GitHub comment that activates a PR-Agent tool, in accordance with the standard privacy policy of PR-Agent. +- The [Qodo-Merge Chrome extension](https://chromewebstore.google.com/detail/qodo-merge-ai-powered-cod/ephlnjeghhogofkifjloamocljapahnl) serves solely to modify the visual appearance of a GitHub PR screen. It does not transmit any user's repo or pull request code. Code is only sent for processing when a user submits a GitHub comment that activates a Qodo-Merge tool, in accordance with the standard privacy policy of Qodo-Merge. ## Links [![Join our Discord community](https://raw.githubusercontent.com/Codium-ai/codiumai-vscode-release/main/media/docs/Joincommunity.png)](https://discord.gg/kG35uSHDBc) - Discord community: https://discord.gg/kG35uSHDBc -- CodiumAI site: https://codium.ai -- Blog: https://www.codium.ai/blog/ -- Troubleshooting: https://www.codium.ai/blog/technical-faq-and-troubleshooting/ -- Support: support@codium.ai +- Qodo site: https://www.qodo.ai/ +- Blog: https://www.qodo.ai/blog/ +- Troubleshooting: https://www.qodo.ai/blog/technical-faq-and-troubleshooting/ +- Support: support@qodo.ai From 4e1cae3869c02203dca8fa88afa9420e30b67521 Mon Sep 17 00:00:00 2001 From: ofir-frd Date: Wed, 22 Jan 2025 10:16:05 +0200 Subject: [PATCH 2/6] docs: remove redundant row number in feature table --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d74c646f..ea1bbe90 100644 --- a/README.md +++ b/README.md @@ -124,7 +124,7 @@ Supported commands per platform: | CORE | [PR compression](https://qodo-merge-docs.qodo.ai/core-abilities/compression_strategy/) | โœ… | โœ… | โœ… | โœ… | | | Adaptive and token-aware file patch fitting | โœ… | โœ… | โœ… | โœ… | | | [Multiple models support](https://qodo-merge-docs.qodo.ai/usage-guide/changing_a_model/) | โœ… | โœ… | โœ… | โœ… | -| 3 | [Local and global metadata](https://qodo-merge-docs.qodo.ai/core-abilities/metadata/) | โœ… | โœ… | โœ… | โœ… | +| | [Local and global metadata](https://qodo-merge-docs.qodo.ai/core-abilities/metadata/) | โœ… | โœ… | โœ… | โœ… | | | [Dynamic context](https://qodo-merge-docs.qodo.ai/core-abilities/dynamic_context/) | โœ… | โœ… | โœ… | โœ… | | | [Self reflection](https://qodo-merge-docs.qodo.ai/core-abilities/self_reflection/) | โœ… | โœ… | โœ… | โœ… | | | [Static code analysis](https://qodo-merge-docs.qodo.ai/core-abilities/static_code_analysis/) ๐Ÿ’Ž | โœ… | โœ… | โœ… | | From 8e5d2a0f4d1c539dc931bc9ad1365c0bf3f0d386 Mon Sep 17 00:00:00 2001 From: ofir-frd Date: Wed, 22 Jan 2025 14:18:23 +0200 Subject: [PATCH 3/6] docs: update branding from PR-Agent to Qodo-Merge in README --- README.md | 60 +++++++++++++++++++++++++++---------------------------- 1 file changed, 30 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index ea1bbe90..5eec7ea6 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@
-Qode Merge PR-Agent aims to help efficiently review and handle pull requests, by providing AI feedback and suggestions +Qodo-Merge PR-Agent aims to help efficiently review and handle pull requests, by providing AI feedback and suggestions [![Static Badge](https://img.shields.io/badge/Chrome-Extension-violet)](https://chromewebstore.google.com/detail/qodo-merge-ai-powered-cod/ephlnjeghhogofkifjloamocljapahnl) @@ -23,9 +23,9 @@ Qode Merge PR-Agent aims to help efficiently review and handle pull requests, by ### [Documentation](https://qodo-merge-docs.qodo.ai/) -- See the [Installation Guide](https://qodo-merge-docs.qodo.ai/installation/) for instructions on installing Qode Merge PR-Agent on different platforms. +- See the [Installation Guide](https://qodo-merge-docs.qodo.ai/installation/) for instructions on installing PR-Agent on different platforms. -- See the [Usage Guide](https://qodo-merge-docs.qodo.ai/usage-guide/) for instructions on running Qode Merge PR-Agent tools via different interfaces, such as CLI, PR Comments, or by automatically triggering them when a new PR is opened. +- See the [Usage Guide](https://qodo-merge-docs.qodo.ai/usage-guide/) for instructions on running PR-Agent tools via different interfaces, such as CLI, PR Comments, or by automatically triggering them when a new PR is opened. - See the [Tools Guide](https://qodo-merge-docs.qodo.ai/tools/) for a detailed description of the different tools, and the available configurations for each tool. @@ -35,9 +35,9 @@ Qode Merge PR-Agent aims to help efficiently review and handle pull requests, by - [Overview](#overview) - [Example results](#example-results) - [Try it now](#try-it-now) -- [Qodo-Merge Pro ๐Ÿ’Ž](https://qodo-merge-docs.qodo.ai/overview/pr_agent_pro/) +- [Qodo-Merge ๐Ÿ’Ž](https://qodo-merge-docs.qodo.ai/overview/pr_agent_pro/) - [How it works](#how-it-works) -- [Why use Qodo-Merge?](#why-use-qodo-merge) +- [Why use PR-Agent?](#why-use-pr-agent) ## News and Updates @@ -54,7 +54,7 @@ Update logic and [documentation](https://qodo-merge-docs.qodo.ai/usage-guide/cha ### December 30, 2024 -Following [feedback](https://research.kudelskisecurity.com/2024/08/29/careful-where-you-code-multiple-vulnerabilities-in-ai-powered-pr-agent/) from the community, we have addressed two vulnerabilities identified in the open-source Qodo-Merge project. The fixes are now included in the newly released version (v0.26), available as of today. +Following [feedback](https://research.kudelskisecurity.com/2024/08/29/careful-where-you-code-multiple-vulnerabilities-in-ai-powered-pr-agent/) from the community, we have addressed two vulnerabilities identified in the open-source PR-Agent project. The fixes are now included in the newly released version (v0.26), available as of today. ### December 25, 2024 @@ -62,11 +62,11 @@ The `review` tool previously included a legacy feature for providing code sugges ### December 2, 2024 -Open-source repositories can now freely use Qodo Merge Pro, and enjoy easy one-click installation using a marketplace [app](https://github.com/apps/qodo-merge-pro-for-open-source). +Open-source repositories can now freely use Qodo-Merge, and enjoy easy one-click installation using a marketplace [app](https://github.com/apps/qodo-merge-pro-for-open-source). -See [here](https://qodo-merge-docs.qodo.ai/installation/pr_agent_pro/) for more details about installing Qodo Merge Pro for private repositories. +See [here](https://qodo-merge-docs.qodo.ai/installation/pr_agent_pro/) for more details about installing Qodo-Merge for private repositories. ### November 18, 2024 @@ -131,7 +131,7 @@ Supported commands per platform: | | [Global and wiki configurations](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/) ๐Ÿ’Ž | โœ… | โœ… | โœ… | | | | [PR interactive actions](https://www.qodo.ai/images/pr_agent/pr-actions.mp4) ๐Ÿ’Ž | โœ… | โœ… | | | | | [Impact Evaluation](https://qodo-merge-docs.qodo.ai/core-abilities/impact_evaluation/) ๐Ÿ’Ž | โœ… | โœ… | | | -- ๐Ÿ’Ž means this feature is available only in [Qodo-Merge Pro](https://www.qodo.ai/pricing/) +- ๐Ÿ’Ž means this feature is available only in [Qodo-Merge](https://www.qodo.ai/pricing/) [//]: # (- Support for additional git providers is described in [here](./docs/Full_environments.md)) ___ @@ -206,7 +206,7 @@ ___ ## Try it now -Try the GPT-4 powered Qodo-Merge PR-Agent instantly on _your public GitHub repository_. Just mention `@CodiumAI-Agent` and add the desired command in any PR comment. The agent will generate a response based on your command. +Try the GPT-4 powered PR-Agent instantly on _your public GitHub repository_. Just mention `@CodiumAI-Agent` and add the desired command in any PR comment. The agent will generate a response based on your command. For example, add a comment to any pull request with the following text: ``` @CodiumAI-Agent /review @@ -220,35 +220,35 @@ It does not have 'edit' access to your repo, for example, so it cannot update th ![Review generation process](https://www.codium.ai/images/demo-2.gif) -To set up your own Qodo-Merge PR-Agent, see the [Installation](https://qodo-merge-docs.qodo.ai/installation/) section below. -Note that when you set your own Qodo-Merge PR-Agent or use Qodo hosted Qodo-Merge PR-Agent, there is no need to mention `@CodiumAI-Agent ...`. Instead, directly start with the command, e.g., `/ask ...`. +To set up your own PR-Agent, see the [Installation](https://qodo-merge-docs.qodo.ai/installation/) section below. +Note that when you set your own PR-Agent or use Qodo hosted PR-Agent, there is no need to mention `@CodiumAI-Agent ...`. Instead, directly start with the command, e.g., `/ask ...`. --- -## Qodo-Merge Pro ๐Ÿ’Ž -[Qodo-Merge Pro](https://www.qodo.ai/pricing/) is a hosted version of Qodo-Merge, provided by Qodo. It is available for a monthly fee, and provides the following benefits: +## Qodo-Merge ๐Ÿ’Ž +[Qodo-Merge](https://www.qodo.ai/pricing/) is a hosted version of Qodo-Merge, provided by Qodo. It is available for a monthly fee, and provides the following benefits: 1. **Fully managed** - We take care of everything for you - hosting, models, regular updates, and more. Installation is as simple as signing up and adding the Qodo-Merge app to your GitHub\GitLab\BitBucket repo. -2. **Improved privacy** - No data will be stored or used to train models. Qodo-Merge Pro will employ zero data retention, and will use an OpenAI account with zero data retention. -3. **Improved support** - Qodo-Merge 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, Qodo-Merge Pro will emphasize more customization, and the usage of static code analysis, in addition to LLM logic, to improve results. -See [here](https://qodo-merge-docs.qodo.ai/overview/pr_agent_pro/) for a list of features available in Qodo-Merge Pro. +2. **Improved privacy** - No data will be stored or used to train models. Qodo-Merge will employ zero data retention, and will use an OpenAI account with zero data retention. +3. **Improved support** - Qodo-Merge 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, Qodo-Merge will emphasize more customization, and the usage of static code analysis, in addition to LLM logic, to improve results. +See [here](https://qodo-merge-docs.qodo.ai/overview/pr_agent_pro/) for a list of features available in Qodo-Merge. ## How it works -The following diagram illustrates Qodo-Merge tools and their flow: +The following diagram illustrates PR-Agent tools and their flow: -![Qodo-Merge Tools](https://www.qodo.ai/images/pr_agent/diagram-v0.9.png) +![PR-Agent Tools](https://www.qodo.ai/images/pr_agent/diagram-v0.9.png) Check out the [PR Compression strategy](https://qodo-merge-docs.qodo.ai/core-abilities/#pr-compression-strategy) page for more details on how we convert a code diff to a manageable LLM prompt -## Why use Qodo-Merge? +## Why use PR-Agent? -A reasonable question that can be asked is: `"Why use Qodo-Merge? What makes 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 Qodo-Merge: +Here are some advantages of PR-Agent: - We emphasize **real-life practical usage**. Each tool (review, improve, ask, ...) has a single GPT-4 call, no more. We feel that this is critical for realistic team usage - obtaining an answer quickly (~30 seconds) and affordably. - Our [PR Compression strategy](https://qodo-merge-docs.qodo.ai/core-abilities/#pr-compression-strategy) is a core ability that enables to effectively tackle both short and long PRs. @@ -258,22 +258,22 @@ Here are some advantages of Qodo-Merge: ## Data privacy -### Self-hosted Qodo-Merge +### Self-hosted PR-Agent -- If you host Qodo-Merge with your OpenAI API key, it is between you and OpenAI. You can read their API data privacy policy here: +- 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 -### Qodo-hosted Qodo-Merge Pro ๐Ÿ’Ž +### Qodo-hosted Qodo-Merge ๐Ÿ’Ž -- When using Qodo-Merge Pro ๐Ÿ’Ž, hosted by Qodo, 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. +- When using Qodo-Merge ๐Ÿ’Ž, hosted by Qodo, 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. -- For certain clients, Qodo-hosted Qodo-Merge Pro will use Qodoโ€™s proprietary models โ€” if this is the case, you will be notified. +- For certain clients, Qodo-hosted Qodo-Merge will use Qodoโ€™s proprietary models โ€” if this is the case, you will be notified. - No passive collection of Code and Pull Requestsโ€™ data โ€” Qodo-Merge will be active only when you invoke it, and it will then extract and analyze only data relevant to the executed command and queried pull request. -### Qodo-Merge Chrome extension +### PR-Agent Chrome extension -- The [Qodo-Merge Chrome extension](https://chromewebstore.google.com/detail/qodo-merge-ai-powered-cod/ephlnjeghhogofkifjloamocljapahnl) serves solely to modify the visual appearance of a GitHub PR screen. It does not transmit any user's repo or pull request code. Code is only sent for processing when a user submits a GitHub comment that activates a Qodo-Merge tool, in accordance with the standard privacy policy of Qodo-Merge. +- The [PR-Agent Chrome extension](https://chromewebstore.google.com/detail/qodo-merge-ai-powered-cod/ephlnjeghhogofkifjloamocljapahnl) serves solely to modify the visual appearance of a GitHub PR screen. It does not transmit any user's repo or pull request code. Code is only sent for processing when a user submits a GitHub comment that activates a PR-Agent tool, in accordance with the standard privacy policy of Qodo-Merge. ## Links From 8a1f07dd6bda295c8969208efe81472ecd2b8273 Mon Sep 17 00:00:00 2001 From: ofir-frd Date: Wed, 22 Jan 2025 14:24:40 +0200 Subject: [PATCH 4/6] docs: clarify Qodo-Merge's open-source nature in README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5eec7ea6..871e7678 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@
-Qodo-Merge PR-Agent aims to help efficiently review and handle pull requests, by providing AI feedback and suggestions +Qodo-Merge's open-source PR-Agent aims to help efficiently review and handle pull requests, by providing AI feedback and suggestions [![Static Badge](https://img.shields.io/badge/Chrome-Extension-violet)](https://chromewebstore.google.com/detail/qodo-merge-ai-powered-cod/ephlnjeghhogofkifjloamocljapahnl) From 0adaddccdf5d2cc5617083eff2902d7960ce901b Mon Sep 17 00:00:00 2001 From: ofir-frd Date: Wed, 22 Jan 2025 14:35:13 +0200 Subject: [PATCH 5/6] docs: update branding from PR-Agent to Qodo-Merge in README --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 871e7678..adcff01f 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ Qodo-Merge's open-source PR-Agent aims to help efficiently review and handle pul - [Try it now](#try-it-now) - [Qodo-Merge ๐Ÿ’Ž](https://qodo-merge-docs.qodo.ai/overview/pr_agent_pro/) - [How it works](#how-it-works) -- [Why use PR-Agent?](#why-use-pr-agent) +- [Why use Qodo-Merge?](#why-use-qodo-merge) ## News and Updates @@ -238,15 +238,15 @@ See [here](https://qodo-merge-docs.qodo.ai/overview/pr_agent_pro/) for a list of ## How it works -The following diagram illustrates PR-Agent tools and their flow: +The following diagram illustrates Qodo-Merge tools and their flow: ![PR-Agent Tools](https://www.qodo.ai/images/pr_agent/diagram-v0.9.png) Check out the [PR Compression strategy](https://qodo-merge-docs.qodo.ai/core-abilities/#pr-compression-strategy) page for more details on how we convert a code diff to a manageable LLM prompt -## Why use PR-Agent? +## Why use Qodo-Merge? -A reasonable question that can be asked is: `"Why use PR-Agent? What makes it stand out from existing tools?"` +A reasonable question that can be asked is: `"Why use Qodo-Merge? What makes it stand out from existing tools?"` Here are some advantages of PR-Agent: From fc5454630a1201a98756d16b7c0045f98726d377 Mon Sep 17 00:00:00 2001 From: ofir-frd Date: Wed, 22 Jan 2025 16:39:14 +0200 Subject: [PATCH 6/6] docs: rebrand from Qodo-Merge to PR-Agent in README --- README.md | 42 +++++++++++++++++++++--------------------- 1 file changed, 21 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index adcff01f..9c999e6b 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@
-Qodo-Merge's open-source PR-Agent aims to help efficiently review and handle pull requests, by providing AI feedback and suggestions +PR-Agent aims to help efficiently review and handle pull requests, by providing AI feedback and suggestions [![Static Badge](https://img.shields.io/badge/Chrome-Extension-violet)](https://chromewebstore.google.com/detail/qodo-merge-ai-powered-cod/ephlnjeghhogofkifjloamocljapahnl) @@ -35,9 +35,9 @@ Qodo-Merge's open-source PR-Agent aims to help efficiently review and handle pul - [Overview](#overview) - [Example results](#example-results) - [Try it now](#try-it-now) -- [Qodo-Merge ๐Ÿ’Ž](https://qodo-merge-docs.qodo.ai/overview/pr_agent_pro/) +- [Qodo Merge ๐Ÿ’Ž](https://qodo-merge-docs.qodo.ai/overview/pr_agent_pro/) - [How it works](#how-it-works) -- [Why use Qodo-Merge?](#why-use-qodo-merge) +- [Why use PR-Agent?](#why-use-pr-agent) ## News and Updates @@ -62,11 +62,11 @@ The `review` tool previously included a legacy feature for providing code sugges ### December 2, 2024 -Open-source repositories can now freely use Qodo-Merge, and enjoy easy one-click installation using a marketplace [app](https://github.com/apps/qodo-merge-pro-for-open-source). +Open-source repositories can now freely use Qodo Merge, and enjoy easy one-click installation using a marketplace [app](https://github.com/apps/qodo-merge-pro-for-open-source). -See [here](https://qodo-merge-docs.qodo.ai/installation/pr_agent_pro/) for more details about installing Qodo-Merge for private repositories. +See [here](https://qodo-merge-docs.qodo.ai/installation/pr_agent_pro/) for more details about installing Qodo Merge for private repositories. ### November 18, 2024 @@ -226,27 +226,27 @@ Note that when you set your own PR-Agent or use Qodo hosted PR-Agent, there is n --- -## Qodo-Merge ๐Ÿ’Ž -[Qodo-Merge](https://www.qodo.ai/pricing/) is a hosted version of Qodo-Merge, provided by Qodo. It is available for a monthly fee, and provides the following benefits: -1. **Fully managed** - We take care of everything for you - hosting, models, regular updates, and more. Installation is as simple as signing up and adding the Qodo-Merge app to your GitHub\GitLab\BitBucket repo. -2. **Improved privacy** - No data will be stored or used to train models. Qodo-Merge will employ zero data retention, and will use an OpenAI account with zero data retention. -3. **Improved support** - Qodo-Merge 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, Qodo-Merge will emphasize more customization, and the usage of static code analysis, in addition to LLM logic, to improve results. -See [here](https://qodo-merge-docs.qodo.ai/overview/pr_agent_pro/) for a list of features available in Qodo-Merge. +## Qodo Merge ๐Ÿ’Ž +[Qodo Merge](https://www.qodo.ai/pricing/) is a hosted version of PR-Agent, provided by Qodo. It is available for a monthly fee, and provides the following benefits: +1. **Fully managed** - We take care of everything for you - hosting, models, regular updates, and more. Installation is as simple as signing up and adding the Qodo Merge app to your GitHub\GitLab\BitBucket repo. +2. **Improved privacy** - No data will be stored or used to train models. Qodo Merge will employ zero data retention, and will use an OpenAI account with zero data retention. +3. **Improved support** - Qodo Merge 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, Qodo Merge will emphasize more customization, and the usage of static code analysis, in addition to LLM logic, to improve results. +See [here](https://qodo-merge-docs.qodo.ai/overview/pr_agent_pro/) for a list of features available in Qodo Merge. ## How it works -The following diagram illustrates Qodo-Merge tools and their flow: +The following diagram illustrates PR-Agent tools and their flow: ![PR-Agent Tools](https://www.qodo.ai/images/pr_agent/diagram-v0.9.png) Check out the [PR Compression strategy](https://qodo-merge-docs.qodo.ai/core-abilities/#pr-compression-strategy) page for more details on how we convert a code diff to a manageable LLM prompt -## Why use Qodo-Merge? +## Why use PR-Agent? -A reasonable question that can be asked is: `"Why use Qodo-Merge? What makes 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: @@ -263,17 +263,17 @@ 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 -### Qodo-hosted Qodo-Merge ๐Ÿ’Ž +### Qodo-hosted Qodo Merge ๐Ÿ’Ž -- When using Qodo-Merge ๐Ÿ’Ž, hosted by Qodo, 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. +- When using Qodo Merge ๐Ÿ’Ž, hosted by Qodo, 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. -- For certain clients, Qodo-hosted Qodo-Merge will use Qodoโ€™s proprietary models โ€” if this is the case, you will be notified. +- For certain clients, Qodo-hosted Qodo Merge will use Qodoโ€™s proprietary models โ€” if this is the case, you will be notified. -- No passive collection of Code and Pull Requestsโ€™ data โ€” Qodo-Merge will be active only when you invoke it, and it will then extract and analyze only data relevant to the executed command and queried pull request. +- No passive collection of Code and Pull Requestsโ€™ data โ€” Qodo Merge will be active only when you invoke it, and it will then extract and analyze only data relevant to the executed command and queried pull request. -### PR-Agent Chrome extension +### Qodo Merge Chrome extension -- The [PR-Agent Chrome extension](https://chromewebstore.google.com/detail/qodo-merge-ai-powered-cod/ephlnjeghhogofkifjloamocljapahnl) serves solely to modify the visual appearance of a GitHub PR screen. It does not transmit any user's repo or pull request code. Code is only sent for processing when a user submits a GitHub comment that activates a PR-Agent tool, in accordance with the standard privacy policy of Qodo-Merge. +- The [Qodo Merge Chrome extension](https://chromewebstore.google.com/detail/qodo-merge-ai-powered-cod/ephlnjeghhogofkifjloamocljapahnl) serves solely to modify the visual appearance of a GitHub PR screen. It does not transmit any user's repo or pull request code. Code is only sent for processing when a user submits a GitHub comment that activates a PR-Agent tool, in accordance with the standard privacy policy of Qodo-Merge. ## Links