Skip to content

Commit 532fbbe

Browse files
authored
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
1 parent 0f8606b commit 532fbbe

File tree

6 files changed

+29
-32
lines changed

6 files changed

+29
-32
lines changed

docs/docs/usage-guide/additional_configurations.md

Lines changed: 21 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -97,33 +97,6 @@ This will set the response language globally for all the commands to Italian.
9797

9898
[//]: # (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))
9999

100-
## Patch Extra Lines
101-
102-
By default, around any change in your PR, git patch provides three lines of context above and below the change.
103-
104-
```
105-
@@ -12,5 +12,5 @@ def func1():
106-
code line that already existed in the file...
107-
code line that already existed in the file...
108-
code line that already existed in the file....
109-
-code line that was removed in the PR
110-
+new code line added in the PR
111-
code line that already existed in the file...
112-
code line that already existed in the file...
113-
code line that already existed in the file...
114-
```
115-
116-
Qodo Merge will try to increase the number of lines of context, via the parameter:
117-
118-
```
119-
[config]
120-
patch_extra_lines_before=3
121-
patch_extra_lines_after=1
122-
```
123-
124-
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.
125-
126-
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.
127100

128101
## Log Level
129102

@@ -158,6 +131,27 @@ LANGSMITH_PROJECT=<project>
158131
LANGSMITH_BASE_URL=<url>
159132
```
160133

134+
## Bringing additional repository metadata to Qodo Merge 💎
135+
136+
To provide Qodo Merge with additional context about your project, you can enable automatic repository metadata detection.
137+
138+
If you set
139+
140+
```toml
141+
[config]
142+
add_repo_metadata = true
143+
```
144+
145+
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:
146+
[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.
147+
148+
You can also specify custom filenames to search for:
149+
150+
```toml
151+
[config]
152+
add_repo_metadata_file_list= ["file1.md", "file2.md", ...]
153+
```
154+
161155
## Ignoring automatic commands in PRs
162156

163157
Qodo Merge allows you to automatically ignore certain PRs based on various criteria:

docs/docs/usage-guide/changing_a_model.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
## Changing a model in PR-Agent
22

3-
See [here](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/algo/__init__.py) for a list of available models.
4-
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:
3+
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.
4+
The default model of PR-Agent is `GPT-5` from OpenAI.
5+
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:
56

67
```toml
78
[config]

docs/docs/usage-guide/index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,5 @@ It includes information on how to adjust Qodo Merge configurations, define which
2222
- [Extra instructions](./additional_configurations.md#extra-instructions)
2323
- [Working with large PRs](./additional_configurations.md#working-with-large-prs)
2424
- [Changing a model](https://qodo-merge-docs.qodo.ai/usage-guide/changing_a_model/)
25-
- [Patch Extra Lines](./additional_configurations.md#patch-extra-lines)
2625
- [FAQ](https://qodo-merge-docs.qodo.ai/faq/)
2726
- [Qodo Merge Models](./qodo_merge_models)

docs/docs/usage-guide/qodo_merge_models.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11

2-
The default models used by Qodo Merge (August 2025) are a combination of GPT-5 and Gemini 2.5 Pro.
2+
The default models used by Qodo Merge 💎 (August 2025) are a combination of GPT-5, Sonnet-4, and Gemini 2.5 Pro.
33

44
### Selecting a Specific Model
55

docs/mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ nav:
2121
- Changing a Model: 'usage-guide/changing_a_model.md'
2222
- Additional Configurations: 'usage-guide/additional_configurations.md'
2323
- Frequently Asked Questions: 'faq/index.md'
24-
- 💎 Qodo Merge Models: 'usage-guide/qodo_merge_models.md'
24+
- Qodo Merge Models: 'usage-guide/qodo_merge_models.md'
2525
- Tools:
2626
- 'tools/index.md'
2727
- Describe: 'tools/describe.md'

pr_agent/settings/configuration.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,9 @@ duplicate_prompt_examples = false
4949
# seed
5050
seed=-1 # set positive value to fix the seed (and ensure temperature=0)
5151
temperature=0.2
52+
# bring repo metadata 💎
53+
add_repo_metadata=false # if true, will try to add metadata from files like 'AGENT.MD', 'CLAUDE.MD', 'QODO.MD' etc.
54+
add_repo_metadata_file_list =["AGENT.MD", "CLAUDE.MD", "QODO.MD"]
5255
# ignore logic
5356
ignore_pr_title = ["^\\[Auto\\]", "^Auto"] # a list of regular expressions to match against the PR title to ignore the PR agent
5457
ignore_pr_target_branches = [] # a list of regular expressions of target branches to ignore from PR agent when an PR is created

0 commit comments

Comments
 (0)