From e9c1c91a4b9c9bd10de845173f5ab441e1c02a6a Mon Sep 17 00:00:00 2001
From: mrT23 <tal.r@codium.ai>
Date: Thu, 23 Jan 2025 12:05:07 +0200
Subject: [PATCH] feat: enhance help message formatting and support for
 different git providers

---
 docs/docs/installation/index.md  |  2 +-
 pr_agent/tools/pr_description.py | 14 ++++++++++++--
 2 files changed, 13 insertions(+), 3 deletions(-)

diff --git a/docs/docs/installation/index.md b/docs/docs/installation/index.md
index a697ebdf..cf5bf2e4 100644
--- a/docs/docs/installation/index.md
+++ b/docs/docs/installation/index.md
@@ -13,5 +13,5 @@ There are several ways to use self-hosted PR-Agent:
 ## Qodo Merge 💎
 Qodo Merge, an app hosted by QodoAI for GitHub\GitLab\BitBucket, is also available.
 <br>
-With Qodo Merge, installation is as simple as adding the Qodo Merge app to your relevant repo.
+With Qodo Merge, installation is as simple as adding the Qodo Merge app to your relevant repositories.
 See [here](https://qodo-merge-docs.qodo.ai/installation/qodo_merge/) for more details.
diff --git a/pr_agent/tools/pr_description.py b/pr_agent/tools/pr_description.py
index e2789a2e..12ba7555 100644
--- a/pr_agent/tools/pr_description.py
+++ b/pr_agent/tools/pr_description.py
@@ -134,8 +134,18 @@ class PRDescription:
                 pr_body += "<hr>\n\n<details> <summary><strong>✨ Describe tool usage guide:</strong></summary><hr> \n\n"
                 pr_body += HelpMessage.get_describe_usage_guide()
                 pr_body += "\n</details>\n"
-            elif get_settings().pr_description.enable_help_comment:
-                pr_body += '\n\n___\n\n> 💡 **PR-Agent usage**: Comment `/help "your question"` on any pull request to receive relevant information'
+            elif get_settings().pr_description.enable_help_comment and self.git_provider.is_supported("gfm_markdown"):
+                if isinstance(self.git_provider, GithubProvider):
+                    pr_body += ('\n\n___\n\n> <details> <summary>  Need help?</summary><li>Type <code>/help how to ...</code> '
+                                'in the comments thread for any questions about PR-Agent usage.</li><li>Check out the '
+                                '<a href="https://qodo-merge-docs.qodo.ai/usage-guide/">documentation</a> '
+                                'for more information.</li></details>')
+                else: # gitlab
+                    pr_body += ("> <details><summary>Need help?</summary>- Type <code>/help how to ...</code> in the comments "
+                                "thread for any questions about PR-Agent usage.<br>- Check out the "
+                                "<a href='https://qodo-merge-docs.qodo.ai/usage-guide/'>documentation</a> for more information.</details>")
+            # elif get_settings().pr_description.enable_help_comment:
+            #     pr_body += '\n\n___\n\n> 💡 **PR-Agent usage**: Comment `/help "your question"` on any pull request to receive relevant information'
 
             # Output the relevant configurations if enabled
             if get_settings().get('config', {}).get('output_relevant_configurations', False):