feat: enhance documentation with additional repository metadata secti… (#2021)

* feat: enhance documentation with additional repository metadata section and update model references

* feat: update default model to GPT-5 and clarify configuration instructions
This commit is contained in:
Tal 2025-09-02 08:40:47 +03:00 committed by GitHub
parent 0f8606b899
commit 532fbbe0a6
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
6 changed files with 29 additions and 32 deletions

View file

@ -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)) [//]: # (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 ## Log Level
@ -158,6 +131,27 @@ LANGSMITH_PROJECT=<project>
LANGSMITH_BASE_URL=<url> LANGSMITH_BASE_URL=<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 ## Ignoring automatic commands in PRs
Qodo Merge allows you to automatically ignore certain PRs based on various criteria: Qodo Merge allows you to automatically ignore certain PRs based on various criteria:

View file

@ -1,7 +1,8 @@
## Changing a model in PR-Agent ## 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. 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.
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: 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 ```toml
[config] [config]

View file

@ -22,6 +22,5 @@ It includes information on how to adjust Qodo Merge configurations, define which
- [Extra instructions](./additional_configurations.md#extra-instructions) - [Extra instructions](./additional_configurations.md#extra-instructions)
- [Working with large PRs](./additional_configurations.md#working-with-large-prs) - [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/) - [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/) - [FAQ](https://qodo-merge-docs.qodo.ai/faq/)
- [Qodo Merge Models](./qodo_merge_models) - [Qodo Merge Models](./qodo_merge_models)

View file

@ -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 ### Selecting a Specific Model

View file

@ -21,7 +21,7 @@ nav:
- Changing a Model: 'usage-guide/changing_a_model.md' - Changing a Model: 'usage-guide/changing_a_model.md'
- Additional Configurations: 'usage-guide/additional_configurations.md' - Additional Configurations: 'usage-guide/additional_configurations.md'
- Frequently Asked Questions: 'faq/index.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:
- 'tools/index.md' - 'tools/index.md'
- Describe: 'tools/describe.md' - Describe: 'tools/describe.md'

View file

@ -49,6 +49,9 @@ duplicate_prompt_examples = false
# seed # seed
seed=-1 # set positive value to fix the seed (and ensure temperature=0) seed=-1 # set positive value to fix the seed (and ensure temperature=0)
temperature=0.2 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 logic
ignore_pr_title = ["^\\[Auto\\]", "^Auto"] # a list of regular expressions to match against the PR title to ignore the PR agent 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 ignore_pr_target_branches = [] # a list of regular expressions of target branches to ignore from PR agent when an PR is created