From 532fbbe0a6f430836183e0d82afec7303060f167 Mon Sep 17 00:00:00 2001 From: Tal <21198860+mrT23@users.noreply.github.com> Date: Tue, 2 Sep 2025 08:40:47 +0300 Subject: [PATCH] =?UTF-8?q?feat:=20enhance=20documentation=20with=20additi?= =?UTF-8?q?onal=20repository=20metadata=20secti=E2=80=A6=20(#2021)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * feat: enhance documentation with additional repository metadata section and update model references * feat: update default model to GPT-5 and clarify configuration instructions --- .../usage-guide/additional_configurations.md | 48 ++++++++----------- docs/docs/usage-guide/changing_a_model.md | 5 +- docs/docs/usage-guide/index.md | 1 - docs/docs/usage-guide/qodo_merge_models.md | 2 +- docs/mkdocs.yml | 2 +- pr_agent/settings/configuration.toml | 3 ++ 6 files changed, 29 insertions(+), 32 deletions(-) diff --git a/docs/docs/usage-guide/additional_configurations.md b/docs/docs/usage-guide/additional_configurations.md index 5ac14296..ccd41347 100644 --- a/docs/docs/usage-guide/additional_configurations.md +++ b/docs/docs/usage-guide/additional_configurations.md @@ -97,33 +97,6 @@ This will set the response language globally for all the commands to Italian. [//]: # (which divides the PR into chunks, and processes each chunk separately. With this mode, regardless of the model, no compression will be done (but for large PRs, multiple model calls may occur)) -## Patch Extra Lines - -By default, around any change in your PR, git patch provides three lines of context above and below the change. - -``` -@@ -12,5 +12,5 @@ def func1(): - code line that already existed in the file... - code line that already existed in the file... - code line that already existed in the file.... --code line that was removed in the PR -+new code line added in the PR - code line that already existed in the file... - code line that already existed in the file... - code line that already existed in the file... -``` - -Qodo Merge will try to increase the number of lines of context, via the parameter: - -``` -[config] -patch_extra_lines_before=3 -patch_extra_lines_after=1 -``` - -Increasing this number provides more context to the model, but will also increase the token budget, and may overwhelm the model with too much information, unrelated to the actual PR code changes. - -If the PR is too large (see [PR Compression strategy](https://github.com/Codium-ai/pr-agent/blob/main/PR_COMPRESSION.md)), Qodo Merge may automatically set this number to 0, and will use the original git patch. ## Log Level @@ -158,6 +131,27 @@ LANGSMITH_PROJECT= LANGSMITH_BASE_URL= ``` +## Bringing additional repository metadata to Qodo Merge 💎 + +To provide Qodo Merge with additional context about your project, you can enable automatic repository metadata detection. + +If you set + +```toml +[config] +add_repo_metadata = true +``` + +Qodo Merge will attempt to fetch repository metadata from the root directory of your PR's head branch, looking for common metadata files such as: +[AGENT.MD](https://agents.md/), [QODO.MD](https://docs.qodo.ai/qodo-documentation/qodo-command/getting-started/setup-and-quickstart), [CLAUDE.MD](https://www.anthropic.com/engineering/claude-code-best-practices), etc. + +You can also specify custom filenames to search for: + +```toml +[config] +add_repo_metadata_file_list= ["file1.md", "file2.md", ...] +``` + ## Ignoring automatic commands in PRs Qodo Merge allows you to automatically ignore certain PRs based on various criteria: diff --git a/docs/docs/usage-guide/changing_a_model.md b/docs/docs/usage-guide/changing_a_model.md index e6926a99..5d62c3e0 100644 --- a/docs/docs/usage-guide/changing_a_model.md +++ b/docs/docs/usage-guide/changing_a_model.md @@ -1,7 +1,8 @@ ## Changing a model in PR-Agent -See [here](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/algo/__init__.py) for a list of available models. -To use a different model than the default (o4-mini), you need to edit in the [configuration file](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L2) the fields: +See [here](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/algo/__init__.py) for a list of supported models in PR-Agent. +The default model of PR-Agent is `GPT-5` from OpenAI. +To use a different model than the default, you need to edit in the [configuration file](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L2) the fields: ```toml [config] diff --git a/docs/docs/usage-guide/index.md b/docs/docs/usage-guide/index.md index 79df0be6..c9b9c852 100644 --- a/docs/docs/usage-guide/index.md +++ b/docs/docs/usage-guide/index.md @@ -22,6 +22,5 @@ It includes information on how to adjust Qodo Merge configurations, define which - [Extra instructions](./additional_configurations.md#extra-instructions) - [Working with large PRs](./additional_configurations.md#working-with-large-prs) - [Changing a model](https://qodo-merge-docs.qodo.ai/usage-guide/changing_a_model/) - - [Patch Extra Lines](./additional_configurations.md#patch-extra-lines) - [FAQ](https://qodo-merge-docs.qodo.ai/faq/) - [Qodo Merge Models](./qodo_merge_models) diff --git a/docs/docs/usage-guide/qodo_merge_models.md b/docs/docs/usage-guide/qodo_merge_models.md index a4a5549c..25a5d3fc 100644 --- a/docs/docs/usage-guide/qodo_merge_models.md +++ b/docs/docs/usage-guide/qodo_merge_models.md @@ -1,5 +1,5 @@ -The default models used by Qodo Merge (August 2025) are a combination of GPT-5 and Gemini 2.5 Pro. +The default models used by Qodo Merge 💎 (August 2025) are a combination of GPT-5, Sonnet-4, and Gemini 2.5 Pro. ### Selecting a Specific Model diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 7c909df9..30860e58 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -21,7 +21,7 @@ nav: - Changing a Model: 'usage-guide/changing_a_model.md' - Additional Configurations: 'usage-guide/additional_configurations.md' - Frequently Asked Questions: 'faq/index.md' - - 💎 Qodo Merge Models: 'usage-guide/qodo_merge_models.md' + - Qodo Merge Models: 'usage-guide/qodo_merge_models.md' - Tools: - 'tools/index.md' - Describe: 'tools/describe.md' diff --git a/pr_agent/settings/configuration.toml b/pr_agent/settings/configuration.toml index 325400d6..4b0ba641 100644 --- a/pr_agent/settings/configuration.toml +++ b/pr_agent/settings/configuration.toml @@ -49,6 +49,9 @@ duplicate_prompt_examples = false # seed seed=-1 # set positive value to fix the seed (and ensure temperature=0) temperature=0.2 +# bring repo metadata 💎 +add_repo_metadata=false # if true, will try to add metadata from files like 'AGENT.MD', 'CLAUDE.MD', 'QODO.MD' etc. +add_repo_metadata_file_list =["AGENT.MD", "CLAUDE.MD", "QODO.MD"] # ignore logic ignore_pr_title = ["^\\[Auto\\]", "^Auto"] # a list of regular expressions to match against the PR title to ignore the PR agent ignore_pr_target_branches = [] # a list of regular expressions of target branches to ignore from PR agent when an PR is created