From 48233fde237ca3c6a8513e81a0ce4d7085b41410 Mon Sep 17 00:00:00 2001 From: mrT23 Date: Thu, 31 Aug 2023 08:02:14 +0300 Subject: [PATCH] Editing the prompts --- CONFIGURATION.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/CONFIGURATION.md b/CONFIGURATION.md index 66ec4f06..67a2be2d 100644 --- a/CONFIGURATION.md +++ b/CONFIGURATION.md @@ -48,6 +48,24 @@ Then when a new PR is opened, PR-Agent will run the `describe` tool with the abo Note that a local `.pr_agent.toml` file enables you to edit and customize the default parameters of any tool, not just the ones that are run automatically. +#### Editing the prompts +The prompts for the different tools of PR-Agent are defined in the `pr_agent/settings` folder. + +In practice, the prompts are loaded and stored as a standard setting object, +so editing them is similar to editing any other configuration value - just place the relevant setting in `.pr_agent.toml`file, and override the default value. + +For example, if you want to edit the prompts of the [describe](./pr_agent/settings/pr_description_prompts.toml) tool, you can add the following to your `.pr_agent.toml` file: +``` +[pr_description_prompt] +system=""" +... +""" +user=""" +... +""" +``` +Note that the new prompt will need to generate an output compatible with the relevant [post-process function](./pr_agent/tools/pr_description.py). + #### Online usage For online usage (calling tools by comments on a PR like `/ask ...`), just add `--config_path=` to any command, to edit a specific configuration value. For example if you want to edit `pr_reviewer` configurations, you can run: