From 38dc9a8fe572262aa4c7f6f27c0accf1a99c5f64 Mon Sep 17 00:00:00 2001 From: mrT23 Date: Sun, 6 Jul 2025 08:52:34 +0300 Subject: [PATCH] docs: clarify behavior of Qodo Merge regarding original PR descriptions --- docs/docs/tools/describe.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/docs/tools/describe.md b/docs/docs/tools/describe.md index 627e6dcf..d929679c 100644 --- a/docs/docs/tools/describe.md +++ b/docs/docs/tools/describe.md @@ -47,11 +47,16 @@ publish_labels = true ## Preserving the original user description -By default, Qodo Merge preserves your original PR description by placing it above the generated content. +By default, Qodo Merge tries to preserve your original PR description by placing it above the generated content. This requires including your description during the initial PR creation. -Be aware that if you edit the description while the automated tool is running, a race condition may occur, potentially causing your original description to be lost. -When updating PR descriptions, the `/describe` tool considers everything above the "PR Type" field as user content and will preserve it. +"Qodo removed the original description from the PR. Why"? + +From our experience, there are two possible reasons: + +- If you edit the description _while_ the automated tool is running, a race condition may occur, potentially causing your original description to be lost. Hence, create a description before launching the PR. + +- When _updating_ PR descriptions, the `/describe` tool considers everything above the "PR Type" field as user content and will preserve it. Everything below this marker is treated as previously auto-generated content and will be replaced. ![Describe comment](https://codium.ai/images/pr_agent/pr_description_user_description.png){width=512}