diff --git a/PR_COMPRESSION.md b/PR_COMPRESSION.md index ef053efe..101874c0 100644 --- a/PR_COMPRESSION.md +++ b/PR_COMPRESSION.md @@ -39,4 +39,4 @@ We use [tiktoken](https://github.com/openai/tiktoken) to tokenize the patches af 4. If we haven't reached the max token length, add the `deleted files` to the prompt until the prompt reaches the max token length (hard stop), skip the rest of the patches. ### Example -![](https://codium.ai/images/git_patch_logic.png) + diff --git a/README.md b/README.md index 2c459ae5..a33fa7cf 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,13 @@
- -
+ + + + + logo + +
Making pull requests less painful with an AI agent
@@ -174,7 +179,7 @@ There are several ways to use PR-Agent: The following diagram illustrates PR-Agent tools and their flow: -![PR-Agent Tools](https://www.codium.ai/wp-content/uploads/2023/10/codiumai-diagram-v5.png) +![PR-Agent Tools](https://codium.ai/images/pr_agent/diagram-v0.9.png) Check out the [PR Compression strategy](./PR_COMPRESSION.md) page for more details on how we convert a code diff to a manageable LLM prompt @@ -220,9 +225,12 @@ See the [Release notes](./RELEASE_NOTES.md) for updates on the latest changes. ## Data Privacy -If you use self-host PR-Agent, e.g. via CLI running on your computer, with your OpenAI API key, it is between you and OpenAI. You can read their API data privacy policy here: +If you use a self-hosted 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 a PR-Agent app hosted by CodiumAI, we will not store any of your data, nor will we used it for training. +You will also benefit from an OpenAI account with zero data retention. + ## Links [![Join our Discord community](https://raw.githubusercontent.com/Codium-ai/codiumai-vscode-release/main/media/docs/Joincommunity.png)](https://discord.gg/kG35uSHDBc) diff --git a/docs/ADD_DOCUMENTATION.md b/docs/ADD_DOCUMENTATION.md index b7204f80..ddb5f402 100644 --- a/docs/ADD_DOCUMENTATION.md +++ b/docs/ADD_DOCUMENTATION.md @@ -7,8 +7,8 @@ It can be invoked manually by commenting on any PR: ``` For example: - - + + ### Configuration options - `docs_style`: The exact style of the documentation (for python docstring). you can choose between: `google`, `numpy`, `sphinx`, `restructuredtext`, `plain`. Default is `sphinx`. diff --git a/docs/ASK.md b/docs/ASK.md index 9ac737e5..72dd0bb0 100644 --- a/docs/ASK.md +++ b/docs/ASK.md @@ -7,5 +7,5 @@ It can be invoked manually by commenting on any PR: ``` For example: - - \ No newline at end of file + + \ No newline at end of file diff --git a/docs/DESCRIBE.md b/docs/DESCRIBE.md index 602294fc..7011a7b5 100644 --- a/docs/DESCRIBE.md +++ b/docs/DESCRIBE.md @@ -7,9 +7,9 @@ It can be invoked manually by commenting on any PR: ``` For example: - + - + The `describe` tool can also be triggered automatically every time a new PR is opened. See examples for automatic triggers for [GitHub App](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) and [GitHub Action](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#working-with-github-action) @@ -52,11 +52,11 @@ The marker `pr_agent:summary` will be replaced with the PR summary, and `pr_agen pr_description.use_description_markers: 'true' ``` - + ==> - + ##### Configuration params: diff --git a/docs/GENERATE_CUSTOM_LABELS.md b/docs/GENERATE_CUSTOM_LABELS.md index c915a0c4..127b215e 100644 --- a/docs/GENERATE_CUSTOM_LABELS.md +++ b/docs/GENERATE_CUSTOM_LABELS.md @@ -9,10 +9,10 @@ For example: If we wish to add detect changes to SQL queries in a given PR, we can add the following custom label along with its description: - + When running the `generate_labels` tool on a PR that includes changes in SQL queries, it will automatically suggest the custom label: - + ### How to enable custom labels diff --git a/docs/IMPROVE.md b/docs/IMPROVE.md index 8204b47b..24d78cbd 100644 --- a/docs/IMPROVE.md +++ b/docs/IMPROVE.md @@ -7,8 +7,8 @@ It can be invoked manually by commenting on any PR: ``` For example: - - + + The `improve` tool can also be triggered automatically every time a new PR is opened. See examples for automatic triggers for [GitHub App](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) and [GitHub Action](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#working-with-github-action) @@ -42,7 +42,7 @@ For example: `/improve --pr_code_suggestions.summarize=true` - + ___ diff --git a/docs/REVIEW.md b/docs/REVIEW.md index ce884448..a63ef47f 100644 --- a/docs/REVIEW.md +++ b/docs/REVIEW.md @@ -7,8 +7,8 @@ It can be invoked manually by commenting on any PR: ``` For example: - - + + The `review` tool can also be triggered automatically every time a new PR is opened. See examples for automatic triggers for [GitHub App](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) and [GitHub Action](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#working-with-github-action) @@ -40,7 +40,7 @@ For an incremental review, which only considers changes since the last PR-Agent ``` Note that the incremental mode is only available for GitHub. - + Under the section 'pr_reviewer', the [configuration file](./../pr_agent/settings/configuration.toml#L16) contains options to customize the 'review -i' tool. These configurations can be used to control the rate at which the incremental review tool will create new review comments when invoked automatically, to prevent making too much noise in the PR. @@ -63,9 +63,9 @@ By invoking: ``` The tool will first ask the author questions about the PR, and will guide the review based on his answers. - - - + + + #### A note on code suggestions quality diff --git a/docs/SIMILAR_ISSUE.md b/docs/SIMILAR_ISSUE.md index 695ef459..501346d0 100644 --- a/docs/SIMILAR_ISSUE.md +++ b/docs/SIMILAR_ISSUE.md @@ -6,9 +6,9 @@ It can be invoked manually by commenting on any PR: ``` For example: - - - + + + Note that to perform retrieval, the `similar_issue` tool indexes all the repo previous issues (once). diff --git a/docs/UPDATE_CHANGELOG.md b/docs/UPDATE_CHANGELOG.md index 3491feeb..dee448f2 100644 --- a/docs/UPDATE_CHANGELOG.md +++ b/docs/UPDATE_CHANGELOG.md @@ -7,8 +7,8 @@ It can be invoked manually by commenting on any PR: ``` For example: - - + + ### Configuration options diff --git a/pics/add_docs.png b/pics/add_docs.png deleted file mode 100644 index 143ae49b..00000000 Binary files a/pics/add_docs.png and /dev/null differ diff --git a/pics/add_docs_comment.png b/pics/add_docs_comment.png deleted file mode 100644 index cd40ff12..00000000 Binary files a/pics/add_docs_comment.png and /dev/null differ diff --git a/pics/ask.png b/pics/ask.png deleted file mode 100644 index 4923829c..00000000 Binary files a/pics/ask.png and /dev/null differ diff --git a/pics/ask_comment.png b/pics/ask_comment.png deleted file mode 100644 index a9d0204d..00000000 Binary files a/pics/ask_comment.png and /dev/null differ diff --git a/pics/custom_label_published.png b/pics/custom_label_published.png deleted file mode 100644 index 7dfffcf6..00000000 Binary files a/pics/custom_label_published.png and /dev/null differ diff --git a/pics/custom_labels_list.png b/pics/custom_labels_list.png deleted file mode 100644 index 4e00caad..00000000 Binary files a/pics/custom_labels_list.png and /dev/null differ diff --git a/pics/describe.png b/pics/describe.png deleted file mode 100644 index 06ad2a6e..00000000 Binary files a/pics/describe.png and /dev/null differ diff --git a/pics/describe_comment.png b/pics/describe_comment.png deleted file mode 100644 index 952c63ec..00000000 Binary files a/pics/describe_comment.png and /dev/null differ diff --git a/pics/describe_markers_after.png b/pics/describe_markers_after.png deleted file mode 100644 index 933cf924..00000000 Binary files a/pics/describe_markers_after.png and /dev/null differ diff --git a/pics/describe_markers_before.png b/pics/describe_markers_before.png deleted file mode 100644 index 2c86653a..00000000 Binary files a/pics/describe_markers_before.png and /dev/null differ diff --git a/pics/improve.png b/pics/improve.png deleted file mode 100644 index 1442a63b..00000000 Binary files a/pics/improve.png and /dev/null differ diff --git a/pics/improve_comment.png b/pics/improve_comment.png deleted file mode 100644 index 3438a4ba..00000000 Binary files a/pics/improve_comment.png and /dev/null differ diff --git a/pics/improved_summerize_closed.png b/pics/improved_summerize_closed.png deleted file mode 100644 index f33d87d3..00000000 Binary files a/pics/improved_summerize_closed.png and /dev/null differ diff --git a/pics/improved_summerize_open.png b/pics/improved_summerize_open.png deleted file mode 100644 index a2bd35c2..00000000 Binary files a/pics/improved_summerize_open.png and /dev/null differ diff --git a/pics/incremental_review.png b/pics/incremental_review.png deleted file mode 100644 index 0118c809..00000000 Binary files a/pics/incremental_review.png and /dev/null differ diff --git a/pics/logo-dark.png b/pics/logo-dark.png deleted file mode 100644 index 852fdb1a..00000000 Binary files a/pics/logo-dark.png and /dev/null differ diff --git a/pics/logo-light.png b/pics/logo-light.png deleted file mode 100644 index e329742f..00000000 Binary files a/pics/logo-light.png and /dev/null differ diff --git a/pics/reflection_answers.png b/pics/reflection_answers.png deleted file mode 100644 index 2a08e0ab..00000000 Binary files a/pics/reflection_answers.png and /dev/null differ diff --git a/pics/reflection_insights.png b/pics/reflection_insights.png deleted file mode 100644 index c8e06d08..00000000 Binary files a/pics/reflection_insights.png and /dev/null differ diff --git a/pics/reflection_questions.png b/pics/reflection_questions.png deleted file mode 100644 index 4512a8a9..00000000 Binary files a/pics/reflection_questions.png and /dev/null differ diff --git a/pics/review.png b/pics/review.png deleted file mode 100644 index 51262f97..00000000 Binary files a/pics/review.png and /dev/null differ diff --git a/pics/review_comment.png b/pics/review_comment.png deleted file mode 100644 index e314dcc4..00000000 Binary files a/pics/review_comment.png and /dev/null differ diff --git a/pics/similar_issue.png b/pics/similar_issue.png deleted file mode 100644 index 923fe97a..00000000 Binary files a/pics/similar_issue.png and /dev/null differ diff --git a/pics/similar_issue_comment.png b/pics/similar_issue_comment.png deleted file mode 100644 index 0e8d2efc..00000000 Binary files a/pics/similar_issue_comment.png and /dev/null differ diff --git a/pics/similar_issue_original_issue.png b/pics/similar_issue_original_issue.png deleted file mode 100644 index b133a872..00000000 Binary files a/pics/similar_issue_original_issue.png and /dev/null differ diff --git a/pics/update_changelog.png b/pics/update_changelog.png deleted file mode 100644 index dd959d9b..00000000 Binary files a/pics/update_changelog.png and /dev/null differ diff --git a/pics/update_changelog_comment.png b/pics/update_changelog_comment.png deleted file mode 100644 index 52caf585..00000000 Binary files a/pics/update_changelog_comment.png and /dev/null differ