Skip to content

Commit

Permalink
Merge pull request #892 from Codium-ai/mrT23-patch-3
Browse files Browse the repository at this point in the history
Update configuration_options.md
  • Loading branch information
mrT23 authored May 8, 2024
2 parents aa60c7d + e8f4a45 commit 5d8d178
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion docs/docs/usage-guide/configuration_options.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,12 @@ There are three ways to set persistent configurations:

In terms of precedence, wiki configurations will override local configurations, and local configurations will override global configurations.

!!! tip "Edit only what you need"

Your configuration file should be minimal, and edit only the relevant values. Don't copy the entire configuration options, since it can lead to legacy problems when something changes.



## Wiki configuration file 💎

Specifically for GitHub, with PR-Agent-Pro you can set configurations by creating a page called `.pr_agent.toml` in the [wiki](https://github.com/Codium-ai/pr-agent/wiki/pr_agent.toml) of the repo.
Expand Down Expand Up @@ -53,4 +59,4 @@ Parameters from a local `.pr_agent.toml` file, in a specific repo, will override

For example, in the GitHub organization `Codium-ai`:
- The repo [`https://github.com/Codium-ai/pr-agent-settings`](https://github.com/Codium-ai/pr-agent-settings/blob/main/.pr_agent.toml) contains a `.pr_agent.toml` file that serves as a global configuration file for all the repos in the GitHub organization `Codium-ai`.
- The repo [`https://github.com/Codium-ai/pr-agent`](https://github.com/Codium-ai/pr-agent/blob/main/.pr_agent.toml) inherits the global configuration file from `pr-agent-settings`.
- The repo [`https://github.com/Codium-ai/pr-agent`](https://github.com/Codium-ai/pr-agent/blob/main/.pr_agent.toml) inherits the global configuration file from `pr-agent-settings`.

0 comments on commit 5d8d178

Please sign in to comment.