xiaxinhang/pr-agent
1
0
Fork 0
mirror of https://github.com/qodo-ai/pr-agent.git synced 2025-07-04 21:00:40 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #360 from zmeir/zmeir-fix_typo_in_describe_md

Browse Source 
Small typo in DESCRIBE.md
This commit is contained in:
mrT23
2023-10-08 16:37:51 +03:00
committed by GitHub
parent 51c817ba29 d77a71bf47
commit 66a5f06b45
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/DESCRIBE.md
View File

@ -23,7 +23,7 @@ Under the section 'pr_description', the [configuration file](./../pr_agent/setti
- `add_original_user_description`: if set to true, the tool will add the original user description to the generated description. Default is false. - `add_original_user_description`: if set to true, the tool will add the original user description to the generated description. Default is false.
- `add_original_user_title`: if set to true, the tool will keep the original PR title, and won't change it. Default is false. - `keep_original_user_title`: if set to true, the tool will keep the original PR title, and won't change it. Default is false.
- `extra_instructions`: Optional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ...". - `extra_instructions`: Optional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ...".
@ -48,4 +48,4 @@ pr_agent:walkthrough
``` ```
The marker `pr_agent:pr_type` will be replaced with the PR type, `pr_agent:summary` will be replaced with the PR summary, and `pr_agent:walkthrough` will be replaced with the PR walkthrough. The marker `pr_agent:pr_type` will be replaced with the PR type, `pr_agent:summary` will be replaced with the PR summary, and `pr_agent:walkthrough` will be replaced with the PR walkthrough.
- `include_generated_by_header`: if set to true, the tool will add a dedicated header: 'Generated by PR Agent at ...' to any automatic content. Default is true. - `include_generated_by_header`: if set to true, the tool will add a dedicated header: 'Generated by PR Agent at ...' to any automatic content. Default is true.